Share via

<summary> (Visual Basic)

  • Artikel

Gibt die Zusammenfassung des Members an.

<summary>description</summary>

Parameter

  • description
    eine Zusammenfassung des Objekts.

Hinweise

Verwenden Sie das <summary>-Tag, um einen Typ oder einen Typmember zu beschreiben. Mit <remarks> (Visual Basic) können Sie zusätzliche Informationen zu einer Typbeschreibung angeben.

Der Text für das <summary>-Tag ist die einzige Quelle von Informationen, die in IntelliSense über den Typ verfügbar sind. Dieser Text wird auch im Objektkatalog angezeigt.

Dokumentationskommentare werden zu einer Datei verarbeitet, indem sie mit /doc kompiliert werden.

Beispiel

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

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