<Сводка> (Visual Basic)
Указывает сводку элемента.
Синтаксис
<summary>description</summary>
Параметры
description
Сводка объекта.
Замечания
<summary>
Используйте тег для описания типа или элемента типа. Используйте <примечания для добавления дополнительных> сведений в описание типа.
Текст <summary>
тега является единственным источником сведений о типе в IntelliSense, а также отображается в браузере объектов. Сведения о браузере объектов см. в разделе "Просмотр структуры кода".
Чтобы обработать комментарии документации и сохранить их в файл, выполняйте сборку с параметром -doc.
Пример
В этом примере тег используется <summary>
для описания ResetCounter
метода и Counter
свойства.
''' <summary>
''' Resets the value of 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