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

  • Article

Le compilateur Visual Basic peut traiter les commentaires de documentation dans votre code et les place dans un fichier XML.Vous pouvez utiliser des outils supplémentaires pour traiter le fichier XML dans la documentation.

Les commentaires XML sont autorisés sur les constructions de code telles que les types et membres de types.Pour les types partiels, seule une partie du type peut contenir des commentaires XML bien qu'elle ne présente aucune restriction sur le commentaire de ses membres.

[!REMARQUE]

Les commentaires de documentation ne peuvent pas être appliqués aux espaces de noms.En effet, un seul espace de noms peut couvrir plusieurs assemblys, et il ne faut pas les charger tous en même temps.

Le compilateur traite n'importe quelle balise représentant du XML correct.Les balises suivantes fournissent des fonctionnalités fréquemment employées dans la documentation utilisateur.

<c>

<code>

<example>

<exception>1

<include>1

<list>

<para>

<param>1

<paramref>

<permission>1

<remarks>

<returns>

<see>1

<seealso>1

<summary>

<typeparam>1

<value>

(1 Le compilateur vérifie la syntaxe.)

[!REMARQUE]

Si vous souhaitez que les signes "inférieur à" et "supérieur à" apparaissent dans le texte d'un commentaire de documentation, utilisez &lt; et &gt;.Par exemple, la chaîne "&lt;text in angle brackets&gt;" apparaît telle que <text in anglebrackets>.

Voir aussi

Tâches

Comment : créer une documentation XML en Visual Basic

Référence

/doc

Concepts

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