<paramref> (C#-Programmierhandbuch)

Syntax

<paramref name="name"/>  

Parameter

name
Der Name des Parameters, auf den verwiesen wird. Setzen Sie den Namen in doppelte Anführungszeichen (" ").

Hinweise

Das Tag <paramref> bietet Ihnen eine Möglichkeit anzugeben, dass sich ein Wort in den Codekommentaren, z.B. in einem <summary>- oder <remarks>-Block, auf einen Parameter bezieht. Die XML-Datei kann so verarbeitet werden, dass dieses Wort anders formatiert wird, z.B. fett oder kursiv.

Dokumentationskommentare werden zu einer Datei verarbeitet, indem sie mit /doc kompiliert werden.

Beispiel

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

Siehe auch

C#-Programmierhandbuch
Empfohlene Tags für Dokumentationskommentare