Teilen über

<Zusammenfassung> (Visual Basic)

  • Artikel

Gibt die Zusammenfassung des Members an.

Syntax

<summary>description</summary>

Parameter

description
Eine Übersicht des Objekts.

Hinweise

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

Der Text für das Tag <summary> stellt die einzige Informationsquelle in Bezug auf den Typ in IntelliSense dar und wird auch im Objektkatalog angezeigt. Informationen zum Objektkatalog finden Sie unter Anzeigen der Codestruktur.

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

Beispiel

In diesem Beispiel wird das <summary>-Tag verwendet, um die ResetCounter-Methode und die 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