<typeparam> (C#-Programmierhandbuch)

Syntax

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

Parameter

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

description
Eine Beschreibung für den Typparameter.

Hinweise

Das <typeparam>-Tag sollte in dem Kommentar für einen generischen Typ oder eine Methodendeklaration zum Beschreiben eines Typparameters verwendet werden. Fügen Sie für jeden Typparameter des generischen Typs oder der Methode ein Tag hinzu.

Weitere Informationen finden Sie unter Generika.

Der Text für das <typeparam>-Tag wird in IntelliSense, dem Object Browser Window-Webbericht für Codekommentare, angezeigt.

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