Recommended Tags for Documentation Comments (Visual C++)
The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.
The latest version of this topic can be found at Recommended Tags for Documentation Comments (Visual C++).
The Visual C++ compiler will process documentation comments in your code and creates an .xdc file for each compiland, and xdcmake.exe will process the .xdc files to an .xml file. Processing the .xml file to create documentation is a detail that needs to be implemented at your site.
Tags are processed on constructs such as types and type members.
Tags must immediately precede types or members.
Note
Documentation comments cannot be applied to a namespace or on out of line definition for properties and events; documentation comments must on the in-class declarations.
The compiler will process any tag that is valid XML. The following tags provide commonly used functionality in user documentation:
| <c> | <code> | <example> |
| <exception>1 | <include>1 | <list> |
| <para> | <param>1 | <paramref>1 |
| <permission>1 | <remarks> | <returns> |
| <see>1 | <seealso>1 | <summary> |
| <value> |
- Compiler verifies syntax.
In the current release, the Visual C++ compiler does not support <paramref>, a tag that is supported by other Visual Studio compilers. Visual C++ may support <paramref> in a future release.