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

Question

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

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

Answer 1

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

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

Answer 2

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

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

Answer 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)

Answer 4

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

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

Answer 5

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