<paramref> (C#-Programmierhandbuch)

  • Artikel
<paramref name="name"/>

Parameter

  • name
    der Name des Parameters, auf den verwiesen werden soll. Der Name muss in doppelte Anführungszeichen (" ") eingeschlossen werden.

Hinweise

Das <paramref>-Tag stellt eine Möglichkeit dar, anzuzeigen, dass es sich bei einem Wort im Codekommentar, beispielsweise in einem <summary>- oder <remarks>-Block, um einen Parameter handelt. Die XML-Datei kann verarbeitet werden, um dieses Wort hervorzuheben, z. B. durch eine Fett- oder Kursivformatierung.

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

Referenz

Empfohlene Tags für Dokumentationskommentare (C#-Programmierhandbuch)

Konzepte

C#-Programmierhandbuch