<value> (Visual Basic)

  • Artikel

Gibt die Beschreibung einer Eigenschaft an.

Syntax

<value>property-description</value>

Parameter

property-description
Eine Beschreibung der Eigenschaft

Hinweise

Verwenden Sie das <value>-Tag, um eine Eigenschaft zu beschreiben. Beachten Sie, dass beim Hinzufügen einer Eigenschaft mithilfe des Code-Assistenten in der Entwicklungsumgebung von Visual Studio der neuen Eigenschaft ein <summary>-Tag hinzugefügt wird. Sie sollten dann manuell ein <value>-Tag für die Beschreibung des Werts hinzufügen, den die Eigenschaft darstellt.

Kompilieren Sie mit -doc, um Dokumentationskommentare zu einer Datei zu verarbeiten.

Beispiel

In diesem Beispiel wird das <value>-Tag verwendet, um zu beschreiben, welchen Wert die Counter-Eigenschaft enthält.

''' <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

Siehe auch