<Beispiel> (Visual Basic)

Gibt ein Beispiel für das Element an.

Syntax

<example>description</example>  

Die Parameter

description
Eine Beschreibung des Codebeispiels.

Bemerkungen

Mit dem <example>-Tag kann ein Beispiel für die Verwendung einer Methode oder eines anderen Bibliothekmembers angegeben werden. Dies umfasst häufig die Verwendung des <Codetags> .

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

Beispiel

In diesem Beispiel wird das <example> Tag verwendet, um ein Beispiel für die Verwendung des ID Felds einzuschließen.

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

• XML-Kommentartags