Commentaires de documentation XML (Guide de programmation C#)

En C#, vous pouvez créer de la documentation pour votre code en incluant des éléments XML dans des champs de commentaire spéciaux (indiqués par trois barres obliques) dans le code source, juste avant le bloc de code auquel les commentaires font référence, par exemple.

/// <summary>
///  This class performs an important function.
/// </summary>
public class MyClass {}

Quand vous compilez avec l’option DocumentationFile , le compilateur recherche toutes les balises XML dans le code source et crée un fichier de documentation XML. Pour créer la documentation finale basée sur le fichier généré par le compilateur, vous pouvez créer un outil personnalisé ou utiliser un outil tel que DocFX ou Sandcastle.

Pour faire référence à des éléments XML (par exemple, votre fonction traite des éléments XML spécifiques que vous souhaitez décrire dans un commentaire de documentation XML), vous pouvez utiliser le mécanisme de citation standard (< et >). Pour faire référence aux identificateurs génériques dans les éléments de référence de code (cref), vous pouvez utiliser des caractères d’échappement (par exemple, cref="List&lt;T&gt;") ou des accolades (cref="List{T}"). En tant que cas particulier, le compilateur analyse les accolades comme des crochets pointus pour rendre le commentaire de documentation moins fastidieux à créer lorsqu'il s'agit de faire référence aux identificateurs génériques.

Notes

Les commentaires de documentation XML ne sont pas des métadonnées. Ils ne sont pas inclus dans l'assembly compilé et ne sont donc pas accessibles par réflexion.

Contenu de cette section

Pour plus d'informations, consultez les pages suivantes :

spécification du langage C#

Pour plus d'informations, voir la spécification du langage C#. La spécification du langage est la source de référence pour la syntaxe C# et son utilisation.

Voir aussi