Condividi tramite

<param> (Guida per programmatori C#)

  • Articolo

Aggiornamento: novembre 2007

<param name='name'>description</param>

Parametri

  • name
    Nome di un parametro di metodo. Racchiudere il nome tra virgolette doppie (" ").

  • description
    Descrizione del parametro.

Note

Il tag <param> viene utilizzato nel commento per una dichiarazione di metodo per descrivere uno dei parametri del metodo.

Il testo del tag <param> verrà visualizzato in IntelliSense, nel 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

// compile with: /doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    /// <param name="Int1">Used to indicate status.</param>
    public static void DoWork(int Int1)
    {
    }
    /// text for Main
    static void Main()
    {
    }
}

Vedere anche

Concetti

Guida per programmatori C#

Riferimenti

Tag consigliati per i commenti relativi alla documentazione (Guida per programmatori C#)