Я пишу библиотеку, и я хочу разместить документацию в своих функциях, чтобы она отображалась в intellisense, вроде того, как intellisense для встроенных функций показывает описания для каждого из параметров и самой функции, Как вы размещаете документацию? Это через комментарии в функции или в каком-то отдельном файле?
Где вы размещаете функциональную документацию так, чтобы она отображалась в intellisense?
Ответ 1
Используйте комментарии XML над сигнатурой функции.
/// <summary>
/// Summary
/// </summary>
/// <param name="param1">Some Parameter.</param>
/// <returns>What this method returns.</returns>
Плагин GhostDoc может помочь сгенерировать их для вас.
Ответ 2
Чтобы автоматически сгенерировать секцию комментариев с тремя косой чертой поверх существующего метода, просто поместите курсор на пустую строку, прямо над определением метода, и введите три косые черты ( "///" ). Visual Studio автоматически генерирует комментарий с тремя слэшами, соответствующий вашему методу. Он будет содержать заполнители для сводки, каждого параметра (если есть) и возвращаемого значения (если есть). Вам просто нужно заполнить пробелы.
Я бы порекомендовал вам не пытаться писать эти блок описания вручную, а не копировать из одного метода в другой. Сторонние инструменты также не нужны для их создания (по крайней мере, в Visual Studio 2010).
Ответ 3
" Комментарии к документации по XML (руководство по программированию на С#) В Visual С# вы можете создать документацию для своего кода, включив теги XML в специальные поля комментариев в исходном коде непосредственно перед кодовым блоком, на который они ссылаются. "
http://msdn.microsoft.com/en-us/library/b2s063f7.aspx
, вы можете использовать Sandcastle для генерации chm файлов, если вы хотите
Ответ 4
Как и комментарии XML, вам необходимо создать сборку документации (в настройках проекта) и сохранить сгенерированный XML файл в сборке.