Partager via

Balises recommandées pour commentaires de documentation (Guide de programmation C#)

  • Article

Mise à jour : novembre 2007

Le compilateur C# traite les commentaires de documentation dans votre code et les place dans un fichier XML. Le traitement du fichier XML en vue de créer la documentation est un détail qui doit être implémenté au niveau de votre site.

Les balises sont traitées sur les constructions de code telles que les types et membres de types.

Remarque :

Les commentaires de documentation ne peuvent pas être appliqués à un espace de noms.

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.

Balises

<c>

<para>

<see>*

<code>

<param>*

<seealso>*

<example>

<paramref>

<summary>

<exception>*

<permission>*

<typeparam>*

<include>*

<remarks>

<typeparamref>

<list>

<returns>

<value>

(* indique que le compilateur vérifie la syntaxe.)

Si vous voulez que des signes « inférieur à » et « supérieur à » apparaissent dans le texte d'un commentaire de documentation, utilisez &lt; et &gt;. Par exemple, &lt;texte en signes inférieur et supérieur à&gt;.

Voir aussi

Tâches

Documentation XML, exemple

Concepts

Guide de programmation C#

Référence

/doc (Traiter les commentaires de documentation) (Options du compilateur C#)

Commentaires de documentation XML (Guide de programmation C#)