<typeparam> (C# Programming Guide)

 

Updated: July 20, 2015

For the latest documentation on Visual Studio 2017 RC, see Visual Studio 2017 RC Documentation.

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

Parameters

name
The name of the type parameter. Enclose the name in double quotation marks (" ").

description
A description for the type parameter.

The <typeparam> tag should be used in the comment for a generic type or method declaration to describe a type parameter. Add a tag for each type parameter of the generic type or method.

For more information, see Generics.

The text for the <typeparam> tag will be displayed in IntelliSense, the Object Browser Window code comment web report.

Compile with /doc to process documentation comments to a file.

    // 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];
        }
    }

C# Reference
C# Programming Guide
Recommended Tags for Documentation Comments

Show: