<param> (C#-Programmierhandbuch)

Syntax

<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. Um mehrere Parameter zu dokumentieren, verwenden Sie mehrere <param>-Tags.

Der Text des <param>-Tags wird in IntelliSense, im Objektkatalog 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
{
    // 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()
    {
    }
}

Siehe auch

C#-Programmierhandbuch
Empfohlene Tags für Dokumentationskommentare