<Exemple> (Visual Basic)

Spécifie un exemple pour le membre.

Syntaxe

<example>description</example>  

Paramètres

description
Description de l’exemple de code.

Remarques

La balise <example> vous permet de spécifier un exemple d’utilisation d’une méthode ou de tout autre membre de la bibliothèque. Cela implique généralement l’utilisation de la balise de <code> .

Compilez avec -doc pour traiter les commentaires de documentation dans un fichier.

Exemple :

Cet exemple utilise la <example> balise pour inclure un exemple d’utilisation du ID champ.

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

Voir aussi

• Balises XML pour les commentaires