Comment : créer une documentation XML en Visual Basic

  • Article

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

Notes

Il est possible que pour certains des éléments de l'interface utilisateur de Visual Studio, votre ordinateur affiche des noms ou des emplacements différents de ceux indiqués 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 Personnalisation de l’IDE.

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

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

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

    Un skeleton XML pour le type ou le membre est ajouté dans l’Éditeur de code.

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

    Notes

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

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

    IntelliSense affiche le texte de l’étiquette <résumé> du type ou du membre.

  5. Compilez le code pour générer un fichier XML contenant les commentaires de documentation. Pour plus d’informations, consultez -doc.

Voir aussi