<param> (Przewodnik programowania w języku C#)

<param name="name">description</param>

Parametry

• name
  Nazwa parametru metody.Nazwę należy ująć w podwójny cudzysłów ("").

• description
  Opis dla parametru.

Uwagi

<param> znacznik stosuje się w komentarz dla deklaracji metody do opisania jednego z parametrów metody.Do dokumentu wiele parametrów, użyć wielu <param> znaczniki.

Tekst dla <param> tag będzie wyświetlany w technologii IntelliSense, przeglądarka obiektów i raport sieci Web kod komentarza.

Kompiluj z /doc do procesu komentarzy dokumentacji do pliku.

Przykład

// 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()
    {
    }
}

Zobacz też

Informacje

Znaczniki zalecane dla komentarzy do dokumentacji (Przewodnik programowania w języku C#)

Koncepcje

Przewodnik programowania w języku C#