Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
Das <summary>-Tag sollte für die Beschreibung eines Typs oder Typmembers verwendet werden. Verwenden Sie <remarks>, um zusätzliche Informationen zu einer Typbeschreibung hinzuzufügen.
Syntax
/// <summary>description</summary>
Parameter
description
Eine Übersicht des Objekts.
Hinweise
Der Text für das <summary> Tag ist die einzige Quelle von Informationen über den Typ in IntelliSense und wird auch im Objektkatalog und im Codekommentar-Webbericht angezeigt.
Kompilieren sie, /doc um Dokumentationskommentare in einer Datei zu verarbeiten.
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() {}
};