<summary> (Visual C++)
Il tag <summary> deve essere utilizzato per descrivere un tipo o un membro del tipo.Utilizzare <remarks> per aggiungere informazioni supplementari alla descrizione di un tipo.
<summary>description</summary>
Parametri
- description
Riepilogo relativo all'oggetto.
Note
Il testo per il tag di <summary> è l'unica fonte di informazioni sul tipo in IntelliSense e visualizza in Visualizzatore oggetti e nel report Web sui commenti del codice.
Eseguire la compilazione con /doc per elaborare in un file i commenti per la creazione della documentazione.
Esempio
// 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() {}
};