Partager via

<example> (Visual Basic)

  • Article

Spécifie un exemple pour le membre.

<example>description</example>

Paramètres

  • description
    Description de l'exemple de code.

Notes

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

Compilez avec /doc pour traiter les commentaires de documentation et les placer dans un fichier.

Exemple

Cet exemple utilise la balise <example> pour inclure un exemple afin d'utiliser le champ ID.

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

Référence

Balises XML recommandées pour les commentaires de documentation (Visual Basic)