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

SyntaxSyntax

<typeparam name="name">description</typeparam>  

ParameterParameters

name
Der Name des Typparameters.The name of the type parameter. Setzen Sie den Namen in einfache oder doppelte Anführungszeichen (" ").Enclose the name in double quotation marks (" ").

description
Eine Beschreibung für den Typparameter.A description for the type parameter.

HinweiseRemarks

Die <typeparam> -Tag sollte im Kommentar für einen generischen Typ oder eine Methodendeklaration verwendet werden, um einen Typparameter zu beschreiben.The <typeparam> tag should be used in the comment for a generic type or method declaration to describe a type parameter. Fügen Sie ein Tag für jeden Typparameter des generischen Typs oder der Methode hinzu.Add a tag for each type parameter of the generic type or method.

Weitere Informationen finden Sie unter Generika.For more information, see Generics.

Der Text für die <typeparam> Tag wird in IntelliSense angezeigt werden, dem Objekt Browserfenster Webbericht für Codekommentare.The text for the <typeparam> tag will be displayed in IntelliSense, the Object Browser Window 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 

/// comment for class
public class TestClass
{
    /// <summary>
    /// Creates a new array of arbitrary type <typeparamref name="T"/>
    /// </summary>
    /// <typeparam name="T">The element type of the array</typeparam>
    public static T[] mkArray<T>(int n)
    {
        return new T[n];
    }
}

Siehe auchSee Also

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