<summary>

Značka <summary> by se měla použít k popisu typu nebo člena typu. Slouží <remarks> k přidání doplňkových informací do popisu typu.

Syntaxe

/// <summary>description</summary>

Parametry

description
Souhrn objektu.

Poznámky

Text značky <summary> je jediným zdrojem informací o typu v IntelliSense a zobrazuje se také v prohlížeči objektů a ve webové sestavě komentáře kódu.

Zkompilujte je /doc pro zpracování komentářů dokumentace k souboru.

Příklad

// 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() {}
};

Viz také

Dokumentace XML