<Zusammenfassung> (Visual Basic)

Gibt die Zusammenfassung des Elements an.

Syntax

<summary>description</summary>  

Die Parameter

description
Eine Zusammenfassung des Objekts.

Bemerkungen

Verwenden Sie das <summary> Tag, um einen Typ oder ein Typmemm zu beschreiben. Verwenden Sie <remarks>, um zusätzliche Informationen zu einer Typbeschreibung hinzuzufügen.

Der Text für das <summary> Tag ist die einzige Quelle von Informationen über den Typ in IntelliSense und wird auch im Objektkatalog angezeigt. Informationen zum Objektbrowser finden Sie unter Anzeigen der Struktur des Codes.

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

Beispiel

In diesem Beispiel wird das <summary> Tag verwendet, um die ResetCounter Methode und Counter Eigenschaft zu beschreiben.

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

• XML-Kommentartags