Guide pratique pour insérer des commentaires XML pour la génération de documentationHow to: Insert XML comments for documentation generation

Visual Studio peut vous aider à documenter des éléments de code, comme les classes et les méthodes, en générant automatiquement la structure de commentaire de documentation XML standard.Visual Studio can help you document code elements such as classes and methods, by automatically generating the standard XML documentation comment structure. Au moment de la compilation, vous pouvez générer un fichier XML qui contient les commentaires de documentation.At compile time, you can generate an XML file that contains the documentation comments. Le fichier XML généré par le compilateur peut être distribué avec votre assembly .NET pour permettre à Visual Studio et à d’autres IDE d’utiliser IntelliSense pour afficher des informations rapides concernant les types et les membres.The compiler-generated XML file can be distributed alongside your .NET assembly so that Visual Studio and other IDEs can use IntelliSense to show quick information about types and members. De plus, le fichier XML peut être exécuté par l’intermédiaire d’outils tels que DocFX et Sandcastle pour générer des sites web de références d’API.Additionally, the XML file can be run through tools like DocFX and Sandcastle to generate API reference websites.

Note

La commande Insérer un commentaire qui insère automatiquement des commentaires de documentation XML est disponible en C# et en Visual Basic.The Insert Comment command that automatically inserts XML documentation comments is available in C# and Visual Basic. Toutefois, vous pouvez insérer manuellement des commentaires de documentation XML dans des fichiers C++ et générer des fichiers de documentation XML au moment de la compilation.However, you can manually insert XML documentation comments in C++ files and still generate XML documentation files at compile time.

Pour insérer des commentaires XML pour un élément de codeTo insert XML comments for a code element

  1. Placez votre curseur sur l’élément que vous souhaitez documenter, par exemple, une méthode.Place your text cursor above the element you want to document, for example, a method.

  2. Effectuez l’une des opérations suivantes :Do one of the following:

    • Tapez /// en C# ou ''' en Visual Basic.Type /// in C#, or ''' in Visual Basic

    • Dans le menu Edition, choisissez IntelliSense > Insérer un commentaire.From the Edit menu, choose IntelliSense > Insert Comment

    • Dans le menu contextuel (clic droit) ou juste au-dessus de l’élément de code, choisissez Extrait > Insérer un commentaire.From the right-click or context menu on or just above the code element, choose Snippet > Insert Comment

    Le modèle XML est généré immédiatement au-dessus de l’élément de code.The XML template is immediately generated above the code element. Par exemple, quand vous commentez une méthode, il génère l’élément <summary>, un élément <param> pour chaque paramètre et un élément <returns> pour documenter la valeur de retour.For example, when commenting a method, it generates the <summary> element, a <param> element for each parameter, and a <returns> element to document the return value.

    Modèle de commentaire XML (C#)

    Modèle de commentaire XML (Visual Basic)

  3. Entrez la description de chaque élément XML pour documenter entièrement l’élément de code.Enter descriptions for each XML element to fully document the code element.

    Commentaire terminé

Note

Une option permet d’activer et de désactiver les commentaires de documentation XML après la saisie des caractères /// en C# ou ''' en Visual Basic.There is an option to toggle XML documentation comments after typing /// in C# or ''' Visual Basic. Dans la barre de menus, choisissez Outils > Options pour ouvrir la boîte de dialogue Options.From the menu bar, choose Tools > Options to open the Options dialog box. Ensuite, accédez à Éditeur de texte > C# ou Basic > Avancé.Then, navigate to Text Editor > C# or Basic > Advanced. Dans la section Aide sur l’éditeur, recherchez l’option Générer des commentaires sur la documentation XML.In the Editor Help section, look for the Generate XML documentation comments option.

Voir aussiSee also

Commentaires de documentation XML (Guide de programmation C#)XML documentation comments (C# Programming Guide)
Documentation de votre code avec des commentaires XML (Guide C#)Documenting your code with XML comments (C# Guide)
Guide pratique pour créer une documentation XML (Visual Basic)How to: Create XML documentation (Visual Basic)
Commentaires en C++C++ Comments
Documentation XML (C++)XML Documentation (C++)
Génération de codeCode generation