Поделиться через

<summary> (Visual Basic)

  • Статья

Задает сводку элемента.

<summary>description</summary>

Параметры

  • description
    Сводка объекта.

Заметки

Используйте тег <summary> для описания типа или члена типа. Используйте <remarks> (Visual Basic), чтобы добавить вспомогательную информацию в описание типа.

Текст тега <summary> единственный источник информации о типе в технологии IntelliSense, а также отображается в обозревателе объектов. Дополнительные сведения об обозревателе объектов см. в разделе Просмотр структуры кода.

Чтобы выделить документирующие комментарии в отдельный файл, необходимо использовать при компиляции параметр /doc.

Пример

В этом примере используется тег <summary> для описания метода ResetCounter и свойства Counter.

''' <summary> 
''' Resets the value the <c>Counter</c> field. 
''' </summary> 
Public Sub ResetCounter()
    counterValue = 0
End Sub 
Private counterValue As Integer = 0
''' <summary> 
''' Returns the number of times Counter was called. 
''' </summary> 
''' <value>Number of times Counter was called.</value> 
Public ReadOnly Property Counter() As Integer 
    Get
        counterValue += 1
        Return counterValue
    End Get 
End Property

См. также

Ссылки

Рекомендуется использовать XML-теги для комментариев документации (Visual Basic)