XML Documentation (Visual C++)
In Visual C++, you can add XML documentation (triple-slash) comments to your source code and instruct the compiler to output them to an .xml file. This file can then be input to a process that creates documentation for the classes in your code. The IDE for Visual C++ in this version does not support XML comments in Intellisense.
XML documentation can be used regardless of whether you compile with or without /clr.
Note
In the current release, code comments are not processed on templates or anything containing a template type (for example, a function taking a parameter as a template). Adding such comments will result in undefined behavior.
For details on creating an .xml file with documentation comments, see the following topics.
For information about |
See |
|---|---|
The compiler options to use |
|
Tags you can use to provide commonly used functionality in documentation |
|
The ID strings that the compiler produces to identify the constructs in your code |
|
How to delimit documentation tags |
|
Generating an .xml file from one or more .xdc files. |
|
Links to information about XML as it relates to Visual Studio feature areas |
If you need to put XML special characters in the text of a documentation comment, you must use XML entities or a CDATA section.