| title |
<summary> (Visual C++) | Microsoft Docs |
| ms.custom |
|
| ms.date |
11/04/2016 |
| ms.reviewer |
|
| ms.suite |
|
| ms.technology |
|
| ms.tgt_pltfrm |
|
| ms.topic |
article |
| f1_keywords |
|
| dev_langs |
|
| helpviewer_keywords |
<summary> C++ XML tag |
summary C++ XML tag |
|
| ms.assetid |
cdeeefbb-1339-45d6-9002-10042a9a2726 |
| caps.latest.revision |
9 |
| author |
mikeblome |
| ms.author |
mblome |
| manager |
ghogen |
| translation.priority.ht |
cs-cz |
de-de |
es-es |
fr-fr |
it-it |
ja-jp |
ko-kr |
pl-pl |
pt-br |
ru-ru |
tr-tr |
zh-cn |
zh-tw |
|
The <summary> tag should be used to describe a type or a type member. Use <remarks> to add supplemental information to a type description.
<summary>description</summary>
description
A summary of the object.
Remarks
The text for the <summary> tag is the only source of information about the type in IntelliSense, and is also displayed in the Object Browser and in the Code Comment Web Report.
Compile with /doc to process documentation comments to a file.
// xml_summary_tag.cpp
// compile with: /LD /clr /doc
// post-build command: xdcmake xml_summary_tag.dll
/// Text for class MyClass.
public ref class MyClass {
public:
/// <summary>MyMethod is a method in the MyClass class.
/// <para>Here's how you could make a second paragraph in a description. <see cref="System::Console::WriteLine"/> for information about output statements.</para>
/// <seealso cref="MyClass::MyMethod2"/>
/// </summary>
void MyMethod(int Int1) {}
/// text
void MyMethod2() {}
};
XML Documentation