Comment : créer une documentation XML en Visual Basic

Cet exemple explique comment ajouter à votre code des commentaires de documentation XML.

[!REMARQUE]

Il est possible que votre ordinateur affiche des noms ou des emplacements différents pour certains des éléments d'interface utilisateur de Visual Studio dans les instructions suivantes. L'édition de Visual Studio dont vous disposez et les paramètres que vous utilisez déterminent ces éléments. Pour plus d'informations, consultez Paramètres Visual Studio.

Pour créer la documentation XML pour un type ou un membre

1. Dans l'éditeur de code, positionnez votre curseur sur la ligne au-dessus du type ou du membre pour lequel vous souhaitez créer la documentation.

2. Tapez ''' (trois guillemets simples).

   Une structure XML pour le type ou le membre est ajoutée dans l'éditeur de code.

3. Ajoutez des informations descriptives entre les balises appropriées.

   [!REMARQUE]

   Si vous ajoutez des lignes supplémentaires dans le bloc de documentation XML, chaque ligne doit commencer par '''.

4. Ajoutez du code supplémentaire qui utilise le type ou le membre avec les nouveaux commentaires de documentation XML.

   IntelliSense affiche le texte de la balise <summary> pour le type ou le membre.

5. Compilez le code pour générer un fichier XML qui contient les commentaires de documentation.Pour plus d'informations, consultez /doc.

Voir aussi

Référence

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

/doc

Concepts

Documentation de votre code avec le langage XML (Visual Basic)