<значение> (Visual Basic)
Указывает описание свойства.
Синтаксис
<value>property-description</value>
Параметры
property-description
Описание свойства.
Замечания
<value>
Используйте тег для описания свойства. Обратите внимание, что при добавлении свойства с помощью мастера кода в среде разработки Visual Studio он добавит <сводный> тег для нового свойства. После этого следует вручную добавить тег <value>
для описания значения, которое представляется свойством.
Чтобы обработать комментарии документации и сохранить их в файл, выполняйте сборку с параметром -doc.
Пример
В этом примере тег используется <value>
для описания значения 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