<summary> (Visual C++)
Тег <summary> следует использовать для описания типа или члена типа.Чтобы добавить дополнительную информацию в описание типа, используйте <remarks>.
<summary>description</summary>
Параметры
- description
Сводка объекта.
Заметки
Текст для тега <summary> единственный источник информации о типе в IntelliSense, а также см. в разделе Обозреватель объектов и в веб-отчет комментариев кода.
Чтобы обработать и сохранить комментарии документации в файл, при компиляции необходимо использовать параметр /doc.
Пример
// 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() {}
};