Как добавить описание функций и параметров функции?

Я пишу функцию VB.NET с тонны перегрузок. Я видел, что большинство функций .NET имеют описания параметров в IntelliSense. Например, при вводе String.Compare(, IntelliSense говорит Compares two specified System.String objects and returns..., вы получаете идею. Это описание изменяется, и вы переходите через разные перегруженные версии тех же функций. Когда вы начинаете вводить что-то для параметра, он описывает параметр, который вы сейчас вводите. Пример: strA: The first string to compare..

Как я могу дать такие описания моим функциям?

Ответ 1

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

''' <summary>
''' Returns the name of the code.
''' </summary>
Function GetName() As String
    Return "Something"
End Function

Ответ 2

Для параметров...

''' <summary>
''' Procedure description
''' </summary>
''' <param name="someVariable">someVariable description.</param>
''' <param name="someVariable">someVariable description.</param>
''' <remarks></remarks>

Ответ 3

Щелкните правой кнопкой мыши имя метода/члена и выберите "Вставить комментарий" из контекстного меню.

Содержимое XML для участника/метода будет отображаться в некоторых версиях Visual Studio, в окнах подсказок intellisense.

    ''' <summary>
    ''' Summary for the method goes here
    ''' </summary>
    ''' <param name="value">Param comments go here</param>
    ''' <remarks></remarks>
Private Sub SomeMethod(ByVal value As Decimal)

Ответ 4

Использовать комментарии xml. Есть некоторые предопределенные теги, которые загружаются в intellisense после компиляции. и замечательно то, что если вы поместите курсор на строку над вашей функцией, тогда нажмите '' '(тройная одинарная кавычка, если это имеет смысл) и введите ее, она заполнит вам кучу вещей. Вот статья:

Документирование кода с комментариями XML

Ответ 5

Поместите курсор на строку перед методом и введите три апострофа ('''). Вы получите шаблон для написания документации XML для метода и его параметров.