<summary> (Visual C++)
Das <summary>-Tag sollte verwendet werden, um einen Typ oder einen Typmember zu beschreiben.Mit <remarks> können Sie zusätzliche Informationen zu einer Typbeschreibung angeben.
<summary>description</summary>
Parameter
- description
eine Zusammenfassung des Objekts.
Hinweise
Der Text für das <summary>-Tag ist die einzige Informationsquelle zu Typ in IntelliSense und wird auch in Objektkatalog und im Webbericht über Codekommentare angezeigt.
Dokumentationskommentare werden zu einer Datei verarbeitet, indem sie mit "/doc" kompiliert werden.
Beispiel
// 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() {}
};