<param> tag della documentazione
Il tag <param> viene usato nel commento di una dichiarazione di metodo per descrivere uno dei parametri del metodo.
Sintassi
/// <param name='param-name'>description</param>
Parametri
param-name
Nome di un parametro di metodo. Racchiudere il nome tra virgolette singole o doppie. Il compilatore genera un avviso se non trova param-name.
description
Descrizione del parametro.
Osservazioni:
Il testo per il <param> tag verrà visualizzato in IntelliSense, nel Visualizzatore oggetti e nel report Web commento codice.
Compilare con /doc per elaborare i commenti della documentazione in un file.
Esempio
// xml_param_tag.cpp
// compile with: /clr /doc /LD
// post-build command: xdcmake xml_param_tag.dll
/// Text for class MyClass.
public ref class MyClass {
/// <param name="Int1">Used to indicate status.</param>
void MyMethod(int Int1) {
}
};