<value> (Visual Basic)

  • Artikel

Gibt die Beschreibung einer Eigenschaft an.

<value>property-description</value>

Parameter

  • property-description
    Eine Beschreibung für die Eigenschaft.

Hinweise

Verwenden Sie das <value>-Tag, um eine Eigenschaft zu beschreiben. Wenn Sie in der Visual Studio-Entwicklungsumgebung über den Code-Assistenten eine Eigenschaft hinzufügen, wird für die neue Eigenschaft ein <summary> (Visual Basic)-Tag hinzugefügt. Fügen Sie dann manuell ein <value>-Tag hinzu, um den Wert zu beschreiben, den die Eigenschaft darstellt.

Damit Dokumentationskommentare zu einer Datei verarbeitet werden, müssen sie mit /doc kompiliert werden.

Beispiel

In diesem Beispiel wird mithilfe des <value>-Tags beschrieben, welchen Wert die Counter-Eigenschaft enthält.

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

Siehe auch

Referenz

Empfohlene XML-Tags für Dokumentationskommentare (Visual Basic)