Cette documentation est archivée et n’est pas conservée.

Comment : créer une documentation XML en Visual Basic

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

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.

    RemarqueRemarque

    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

Afficher: