Partager via

Guide pratique pour créer une documentation XML dans Visual Basic

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

Remarque

Votre ordinateur peut afficher différents noms ou emplacements pour certains des éléments de l’interface utilisateur Visual Studio dans les instructions suivantes. L’édition Visual Studio que vous avez et les paramètres que vous utilisez déterminent ces éléments. Pour plus d’informations, consultez Personnaliser l’IDE.

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

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

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

    Un squelette XML pour le type ou le membre est ajouté 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 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