<summary>

Tag <summary> powinien służyć do opisywania typu lub elementu członkowskiego typu. Służy <remarks> do dodawania informacji uzupełniających do opisu typu.

Składnia

/// <summary>description</summary>

Parametry

description
Podsumowanie obiektu.

Uwagi

Tekst tagu <summary> jest jedynym źródłem informacji o typie w funkcji IntelliSense i jest również wyświetlany w przeglądarce obiektów i w raporcie sieci Web komentarza kodu.

Skompiluj element , /doc aby przetworzyć komentarze 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ż

Dokumentacja XML