<param> (C#-Programmierhandbuch)

  • Artikel

Aktualisiert: November 2007

<param name='name'>description</param>

Parameter

  • name
    der Name des Methodenparameters. Der Name muss in doppelte Anführungszeichen (" ") eingeschlossen werden.

  • description
    eine Beschreibung für den Parameter.

Hinweise

Das <param>-Tag sollte im Kommentar für eine Methodendeklaration verwendet werden, um einen der Parameter der Methode zu beschreiben.

Der Text des <param>-Tags wird in IntelliSense, im Objektbrowser und im Webbericht über Codekommentare angezeigt.

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

Siehe auch

Konzepte

C#-Programmierhandbuch

Referenz

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