Udostępnij za pośrednictwem


<summary> (Visual C++)

<summary> znacznik stosuje się do opisu typu lub członka typu.Użycie <remarks> Aby dodać informacje uzupełniające dla opisu typu.

<summary>description</summary>

Parametry

  • description
    Krótki opis obiektu.

Uwagi

Tekst dla <summary> Tag jest jedynym źródłem informacji o typie w technologii IntelliSense i jest wyświetlany w Przeglądarka obiektów i w sprawozdaniu Web kod komentarza.

Kompilacji z /doc do procesu komentarzy dokumentacji do pliku.

Przykład

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

Zobacz też

Inne zasoby

Dokumentacja XML (Visual C++)