<typeparamref> (C# Programming Guide)

 

Updated: July 20, 2015

System_CAPS_ICON_note.jpg Note

For the latest documentation on C#, visit the C# Guide on docs.microsoft.com.

<typeparamref name="name"/>  

Parameters

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

For more information on type parameters in generic types and methods, see Generics.

Use this tag to enable consumers of the documentation file to format the word in some distinct way, for example in italics.

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# Programming Guide
Recommended Tags for Documentation Comments

Show: