<param> (C#-Programmierhandbuch)<param> (C# Programming Guide)

SyntaxSyntax

<param name="name">description</param>  

ParameterParameters

name
Der Name eines Methodenparameters.The name of a method parameter. Setzen Sie den Namen in doppelte Anführungszeichen (" ").Enclose the name in double quotation marks (" ").

description
Eine Beschreibung für den ParameterA description for the parameter.

HinweiseRemarks

Das <param>-Tag sollte im Kommentar für eine Methodendeklaration verwendet werden, um einen der Methodenparameter zu beschreiben.The <param> tag should be used in the comment for a method declaration to describe one of the parameters for the method. Um mehrere Parameter zu dokumentieren, verwenden Sie mehrere <param>-Tags.To document multiple parameters, use multiple <param> tags.

Der Text für den <param>-Tag wird in IntelliSense, dem Objektkatalog, und im Webbericht für Codekommentare angezeigt.The text for the <param> tag will be displayed in IntelliSense, the Object Browser, and in the Code Comment Web Report.

Dokumentationskommentare werden zu einer Datei verarbeitet, indem sie mit /doc kompiliert werden.Compile with /doc to process documentation comments to a file.

BeispielExample

// 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 auchSee Also

C#-ProgrammierhandbuchC# Programming Guide
Empfohlene Tags für DokumentationskommentareRecommended Tags for Documentation Comments