<param> (Guida per programmatori C#)

<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. Per documentare più parametri, utilizzare più tag <param>.

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
{
    // Single parameter. 
    /// <param name="Int1">Used to indicate status.</param>
    public static void DoWork(int Int1)
    {
    }

    // Multiple parameters. 
    /// <param name="Int1">Used to indicate status.</param>
    /// <param name="Float1">Used to specify context.</param>
    public static void DoWork(int Int1, float Float1)
    {
    }

    /// text for Main 
    static void Main()
    {
    }
}

Vedere anche

Riferimenti

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

Concetti

Guida per programmatori C#