Sdílet prostřednictvím


<summary> (Visual C++)

<summary> značka by měla sloužit k popisu typu nebo člena typu.Použití <remarks> Chcete-li přidat doplňkové informace pro popis typu.

<summary>description</summary>

Parametry

  • description
    Přehled objektu.

Poznámky

Text pro <summary> značka je jediným zdrojem informací o typu v technologii IntelliSense a také je zobrazena v Prohlížeč objektů a v kódu komentář webové sestavy.

Kompilace s /doc k procesu dokumentační komentáře do 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é

Další zdroje

XML dokumentace (Visual C++)