| title | ms.date | ms.topic | author | ms.author | manager | ms.workload | |
|---|---|---|---|---|---|---|---|
Insert XML documentation comments |
01/26/2018 |
reference |
gewarren |
gewarren |
jillfra |
|
Visual Studio can help you document code elements such as classes and methods, by automatically generating the standard XML documentation comment structure. At compile time, you can generate an XML file that contains the documentation comments.
Tip
For information about configuring the name and location of the generated XML file, see Documenting your code with XML comments (C# Guide).
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. Additionally, the XML file can be run through tools like DocFX and Sandcastle to generate API reference websites.
Note
The Insert Comment command that automatically inserts XML documentation comments is available in C# and Visual Basic. However, you can manually insert XML documentation comments in C++ files and still generate XML documentation files at compile time.
-
Place your text cursor above the element you want to document, for example, a method.
-
Do one of the following:
-
Type
///in C#, or'''in Visual Basic -
From the Edit menu, choose IntelliSense > Insert Comment
-
From the right-click or context menu on or just above the code element, choose Snippet > Insert Comment
The XML template is immediately generated above the code element. 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.
-
-
Enter descriptions for each XML element to fully document the code element.
Note
There is an option to toggle XML documentation comments after typing /// in C# or ''' Visual Basic. From the menu bar, choose Tools > Options to open the Options dialog box. Then, navigate to Text Editor > C# or Basic > Advanced. In the Editor Help section, look for the Generate XML documentation comments option.