Partager via

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

  • Article

Le compilateur C# traite des commentaires de documentation dans votre code et les met en forme dans un fichier XML dont vous spécifiez le nom dans l'option de ligne de commande /doc.Pour créer la documentation finale sur le fichier généré par le compilateur, vous pouvez créer un outil personnalisé, ou utilisez un outil Pâté de sable (sandbox)tel que.

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 souhaitez des crochets pointus pour apparaître dans le texte d'un commentaire de documentation, d'une utilisation &lt; et &gt;, comme indiqué dans l'exemple suivant.

/// <summary cref="C &lt; T &gt;">
/// </summary>

Voir aussi

Référence

/doc (Options du compilateur C#)

Commentaires de documentation XML (Guide de programmation C#)

Concepts

Guide de programmation C#