| description | Learn more about: XML documentation tag <c> | ||
|---|---|---|---|
| title | <c> (C++ documentation comments) | ||
| ms.date | 11/04/2016 | ||
| f1_keywords |
|
||
| helpviewer_keywords |
|
||
| ms.assetid | 3b23fc0f-e10d-4dd0-b197-48a46cbddd9f |
The <c> tag indicates that text within a description should be marked as code. Use <code> to indicate multiple lines as code.
/// <c>text</c>text
The text you want to indicate as code.
Compile with /doc to process documentation comments to a file.
// xml_c_tag.cpp
// compile with: /doc /LD
// post-build command: xdcmake xml_c_tag.xdc
/// Text for class MyClass.
class MyClass {
public:
int m_i;
MyClass() : m_i(0) {}
/// <summary><c>MyMethod</c> is a method in the <c>MyClass</c> class.
/// </summary>
int MyMethod(MyClass * a) {
return a -> m_i;
}
};