Куда вы помещаете документацию функции, чтобы она отображалась на intellisense?

Question

Я пишу библиотеку и хочу поместить документацию в свои функции, чтобы она отображалась в intellisense, что-то вроде того, как intellisense для встроенных функций показывает описания для каждого из параметров и для самой функции , Как вы кладете документацию? Это через комментарии в функции или в каком-то отдельном файле?

Answer 1

Используйте комментарии XML над сигнатурой функции.

    /// <summary>
    /// Summary
    /// </summary>
    /// <param name="param1">Some Parameter.</param>
    /// <returns>What this method returns.</returns>

Плагин GhostDoc может помочь вам сгенерировать их.

Answer 2

Чтобы автоматически сгенерировать секцию комментария с тремя слешами поверх существующего метода, просто поместите курсор на пустую строку, прямо над определением метода и введите три косые черты ("///"). Visual Studio автоматически сгенерирует трехслойный комментарий, соответствующий вашему методу. Он будет содержать заполнители для сводки, каждого параметра (если есть) и возвращаемого значения (если есть). Вам просто нужно заполнить пробелы.

Я бы порекомендовал вам не пытаться писать эти блоки описания вручную и не копировать из одного метода в другой. Сторонние инструменты также не нужны для их генерации (по крайней мере, в Visual Studio 2010).

Answer 3

" Комментарии к документации XML (Руководство по программированию в C #) В Visual C # вы можете создавать документацию для своего кода, включая теги XML в специальные поля комментариев в исходном коде непосредственно перед блоком кода, на который они ссылаются. "

http://msdn.microsoft.com/en-us/library/b2s063f7.aspx

затем вы можете использовать Sandcastle для создания файлов CHM, если хотите

http://www.hanselman.com/blog/SandcastleMicrosoftCTPOfAHelpCHMFileGeneratorOnTheTailsOfTheDeathOfNDoc.aspx

Answer 4

Как и комментарии XML, вам нужно включить сборку документации (в настройках проекта) и сохранить сгенерированный файл XML вместе со сборкой.