Nota
L'accesso a questa pagina richiede l'autorizzazione. È possibile provare ad accedere o modificare le directory.
L'accesso a questa pagina richiede l'autorizzazione. È possibile provare a modificare le directory.
Il tag <summary> deve essere usato per descrivere un tipo o un membro del tipo. Utilizzare <remarks> per aggiungere informazioni supplementari a una descrizione del tipo.
Sintassi
/// <summary>description</summary>
Parametri
description
Un riepilogo dell'oggetto.
Osservazioni:
Il testo per il <summary> tag è l'unica origine di informazioni sul tipo in IntelliSense e viene visualizzato anche nel Visualizzatore oggetti e nel report Web commento codice.
Compilare con /doc per elaborare i commenti della documentazione in un file.
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() {}
};