Как получить комментарии в IntelliSense для функции в Visual Studio?

что нужно комментарии xml - в основном, они следуют этому синтаксису (как смутно описано Solmead):

C#

///<summary>
///This is a description of my function.
///</summary>
string myFunction() {
     return "blah";
}

В. Б.

'''<summary>
'''This is a description of my function.
'''</summary>
Function myFunction() As String
    Return "blah"
End Function

<c>text</c> - текст, который вы хотели бы указать как код.
В c> тег дает вам способ, чтобы указать, что текст в описании должен быть помечен как код. Используйте код> для указания нескольких строк в качестве кода.

<code>content</code> - текст, который вы хотите отметить как код.
В код> тег дает вам способ указать несколько строк в качестве кода. Используйте c>, чтобы указать, что текст в описании должен быть помечено как код.

<example>description</example> - описание примера кода.
В пример> тег позволяет указать пример использования метода или другого элемента библиотеки. Это обычно включает в себя использование код> тег.

<exception cref="member">description</exception> - описание исключения.
В исключение> тег позволяет указать, какие исключения могут быть брошены. Этот тег может применяться к определениям методов, свойств, событий и т. д индексаторы.

<include file='filename' path='tagpath[@name="id"]' />
В включить> тег позволяет ссылаться на комментарии в другом файле, которые описывают типы и члены в исходном коде. Это альтернатива размещению комментариев к документации непосредственно в файле исходного кода. Поместив документацию в отдельный файл, можно применить к документации систему управления версиями отдельно от исходного кода. Один человек может получить файл исходного кода, а кто-то другой может иметь файл документации проверен. В включить> тег использует синтаксис XML XPath. См. документацию XPath для способов настройки вашего включить> использовать.

<list type="bullet" | "number" | "table">
    <listheader>
        <term>term</term>
        <description>description</description>
    </listheader>
    <item>
        <term>term</term>
        <description>description</description>
    </item>
</list>

The listheader> блок используется для определения строки заголовка таблицы или списка определений. При определении таблицы вам нужно только указать запись для термина в заголовке. Каждый элемент в списке указывается с помощью item> блок. При создании списка определений, необходимо указать сроки и описание. Однако для таблицы, маркированного списка или нумерованного списка необходимо только указать запись для описания. Список или таблица может иметь столько item> блоки по мере необходимости.

<para>content</para>
В para> тег предназначен для использования внутри тега, например резюме>,Примечания>, или возвращает>, и позволяет добавить структуру текст.

<param name="name">description</param>
В параметр> тег должен использоваться в комментарии для объявления метода для описания одного из параметров метода. Для документирования нескольких параметров используйте несколько параметр> теги.
Текст для параметр> тег будет отображаться в IntelliSense, Обозревателе объектов и в веб-отчете комментария кода.

<paramref name="name"/>
В paramref> тег дает вам способ указать, что слово в коде комментирует, например в резюме> или Примечания> блок относится к параметру. XML-файл может быть обработан для форматирования этого слова каким-то особым образом, например, полужирным или курсивным шрифтом.

permission cref="member">description</permission>
В разрешение> тег позволяет документировать доступ члена. Класс PermissionSet позволяет указать доступ к члену.

<remarks>description</remarks>
Этот Примечания> тег используется для добавления информации о типе, дополняя информацию, указанную с резюме>. Эта информация отображается в Обозревателе объектов.

<returns>description</returns>
В возвращает> тег должен использоваться в комментарии для объявления метода для описания возвращаемого значения.

<see cref="member"/>
В посмотреть> тег позволяет указать ссылку из текста. Использовать seealso> чтобы указать, что текст должен быть помещен в разделе. Используйте атрибут cref для создания внутренних гиперссылок на страницы документации для элементов кода.

<seealso cref="member"/>
В seealso> тег позволяет указать текст, который нужно отобразить в разделе. Используйте посмотреть> чтобы указать ссылку в тексте.

<summary>description</summary>
В резюме> тег должен использоваться для опишите тип или член типа. Используйте Примечания> чтобы добавить дополнительную информацию к описанию типа. Используйте атрибут cref, чтобы включить инструменты документации, такие как Sandcastle, для создания внутренних гиперссылок на страницы документации для элементов кода. Текст для резюме> тег является единственным источником информации о типе в IntelliSense, а также отображается в Обозревателе объектов.

<typeparam name="name">description</typeparam>
В typeparam> тег должен использоваться в комментарии для объявления универсального типа или метода для описания параметра типа. Добавьте тег для каждого параметра типа универсального типа или метода. Текст для typeparam> тег будет отображаться в IntelliSense, веб-отчете комментарий кода обозревателя объектов.

<typeparamref name="name"/>
Используйте этот тег, чтобы пользователи файла документации могли форматировать слово определенным образом, например курсивом.

<value>property-description</value>
В стоимостью> тег позволяет описать значение, которое представляет свойство. Обратите внимание, что при добавлении свойства с помощью мастера кода в среде разработки Visual Studio .NET, он добавит резюме> тег для нового свойства. Затем вы должны вручную добавить стоимостью> тег для описания значения, которое представляет свойство.

комментировать XML, как это

/// <summary>
/// This does something that is awesome
/// </summary>
public void doesSomethingAwesome() {}

Это называется комментарии XML. Они были частью Visual Studio с тех пор навсегда.

вы можете сделать ваш процесс документации проще с помощью GhostDoc, бесплатная надстройка для Visual Studio, которая генерирует комментарии XML-doc для вас. Просто поместите курсор на метод / свойство, которое вы хотите документировать, и нажмите Ctrl-Shift-D.

вот пример один из моих постов.

надеюсь, что это поможет:)

используйте ///, чтобы начать каждую строку комментария и иметь комментарий содержит соответствующий xml для считывателя метаданных.

///<summary>
/// this method says hello
///</summary>
public void SayHello();

хотя лично я считаю, что эти комментарии обычно вводят в заблуждение, если вы не разрабатываете классы, где код не может быть прочитан его потребителями.

в CSharp, если вы создадите контур метода/функции с его Parms, то при добавлении трех прямых косых черт он автоматически создаст раздел summary и parms.

Так что:

public string myMethod(string sImput1, int iInput2)
{
}

затем я поставил три / / / перед ним, и Visual Studio дал мне это:

/// <summary>
/// 
/// </summary>
/// <param name="sImput1"></param>
/// <param name="iInput2"></param>
/// <returns></returns>
public string myMethod(string sImput1, int iInput2)
{
}

читать http://msdn.microsoft.com/en-us/library/3260k4x7.aspx просто указав комментарии, вы не увидите комментарии справки в intellisense.

определите такие методы, и вы получите необходимую вам помощь.

    /// <summary>
    /// Adds two numbers and returns the result
    /// </summary>
    /// <param name="first">first number to add</param>
    /// <param name="second">second number to </param>
    /// <returns></returns>
    private int Add(int first, int second)
    {
        return first + second;
    }

скриншот использования кода

кроме того, надстройка Visual studio ghost doc попытается создать и заполнить комментарии заголовка из имени вашей функции.

все остальные ответы имеют смысл, но являются неполными. Visual Studio будет обрабатывать комментарии XML, но вы должны включить их. Вот как это сделать:

Intellisense будет использовать комментарии XML, введенные в исходном коде, но они должны быть включены с помощью параметров Visual Studio. Перейти к Tools>Options>Text Editor. Для Visual Basic включите Advanced>Generate XML documentation comments for ''' настройка. Для C# включить Advanced>Generate XML documentation comments for /// настройка. Intellisense будет использовать сводные комментарии когда вошел. Они будут доступны из других проектов после компиляции указанного проекта.

создать внешний документация, вам нужно создать XML-файл через Project Settings>Build>XML documentation file: путь, который управляет компилятором . Вам понадобится внешний инструмент, который будет принимать XML-файл в качестве входных данных и генерировать документацию на ваш выбор выходных форматов.

имейте в виду, что создание XML-файла может заметно увеличить время компиляции.

Solmead имеет правильный ответ. Для получения дополнительной информации вы можете посмотреть комментарии XML.