Commentaires de documentation XML (Guide de programmation C#)XML Documentation Comments (C# Programming Guide)

Dans Visual C #, vous pouvez créer de la documentation de 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 :In Visual C# you can create documentation for your code by including XML elements in special comment fields (indicated by triple slashes) in the source code directly before the code block to which the comments refer, for example:

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

Quand vous utilisez l’option /doc pour compiler, le compilateur recherche toutes les balises XML dans le code source et crée un fichier de documentation XML.When you compile with the /doc option, the compiler will search for all XML tags in the source code and create an XML documentation file. 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.To create the final documentation based on the compiler-generated file, you can create a custom tool or use a tool such as DocFX or 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 >).To refer to XML elements (for example, your function processes specific XML elements that you want to describe in an XML documentation comment), you can use the standard quoting mechanism (< and >). 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}").To refer to generic identifiers in code reference (cref) elements, you can use either the escape characters (for example, cref="List&lt;T&gt;") or braces (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.As a special case, the compiler parses the braces as angle brackets to make the documentation comment less cumbersome to author when referring to generic identifiers.

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.The XML documentation comments are not metadata; they are not included in the compiled assembly and therefore they are not accessible through reflection.

Dans cette sectionIn This Section

Pour plus d'informations, voir :For more information, see:

Spécification du langage C#C# Language Specification

Pour plus d'informations, voir la spécification du langage C#.For more information, see the C# Language Specification. La spécification du langage est la source de référence pour la syntaxe C# et son utilisation.The language specification is the definitive source for C# syntax and usage.

Voir aussiSee also