Share via

<example> (Visual Basic)

  • Artikel

Gibt ein Beispiel für den Member an.

<example>description</example>

Parameter

  • description
    eine Beschreibung des Codebeispiels.

Hinweise

Mit dem <example>-Tag kann ein Beispiel für die Verwendung einer Methode oder eines anderen Bibliothekmembers angegeben werden. Dies beinhaltet im Allgemeinen die Verwendung des <code> (Visual Basic)-Tags.

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

Beispiel

In diesem Beispiel wird das <example>-Tag verwendet, um ein Beispiel für die Verwendung des ID-Feldes einzufügen.

Public Class Employee
    ''' <remarks>
    ''' <example> This sample shows how to set the <c>ID</c> field.
    ''' <code>
    ''' Dim alice As New Employee
    ''' alice.ID = 1234
    ''' </code>
    ''' </example>
    ''' </remarks>
    Public ID As Integer
End Class

Siehe auch

Referenz

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