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

Также дополнительный фантомный документ Visual Studio попытается создать и временная замена комментарии заголовка с Вашего имени функции.

Сделайте комментарий XML, как это

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

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

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

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

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

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

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

Вот пример от одно из моих сообщений .

Hope, которая помогает:)

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

C#

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

VB

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