<typeparam> (C#-Programmierhandbuch)

Syntax

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

Parameter

name
Der Name des Typparameters. Setzen Sie den Namen in einfache oder doppelte Anführungszeichen (" ").

description
Eine Beschreibung für den Typparameter.

Hinweise

Die <typeparam> -Tag sollte im Kommentar für einen generischen Typ oder eine Methodendeklaration verwendet werden, um einen Typparameter zu beschreiben. Fügen Sie ein Tag für jeden Typparameter des generischen Typs oder der Methode hinzu.

Weitere Informationen finden Sie unter Generika.

Der Text für die <typeparam> Tag wird in IntelliSense angezeigt werden, dem Objekt Browserfenster Webbericht für Codekommentare.

Dokumentationskommentare werden zu einer Datei verarbeitet, indem sie mit /doc kompiliert werden.

Beispiel

// 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 auch

C#-Referenz
C#-Programmierhandbuch
Empfohlene Tags für Dokumentationskommentare