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

  • Artykuł
<paramref name="name"/>

Parametry

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

Uwagi

<paramref> Tag daje sposób, aby wskazać, że wyraz w kodzie komentarze, na przykład w <summary> lub <remarks> blok odnosi się do parametru.Plik XML mogą być przetwarzane na format tego słowa w jakiś sposób distinct, takich jak przy użyciu czcionki pogrubione lub pisane kursywą.

Kompiluj z /doc do procesu komentarzy dokumentacji do pliku.

Przykład

// compile with: /doc:DocFileName.xml  

/// text for class TestClass 
public class TestClass
{
    /// <summary>DoWork is a method in the TestClass class.   
    /// The <paramref name="Int1"/> parameter takes a number.
    /// </summary> 
    public static void DoWork(int Int1)
    {
    }

    /// 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#