The <typeparamref> tag gives you a way to indicate that a word in the code comments, for example in a <summary> or <remarks> block refers to a type parameter. This is usually displayed with italic font.

Syntax

<typeparamref name="name"/>

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

Examples

Visual Basic

''' <summary>Represents a key-value pair where the key

''' is of type <typeparamref name="Tkey"> and can be sorted.</summary>

Public Class SortableKeyValuePair(Of Tkey As IComparable, Tvalue)

C#

/// <summary>Represents a key-value pair where the key

/// is of type <typeparamref name="Tkey"> and can be sorted.</summary>

public class SortableKeyValuePair<Tkey, Tvalue> where Tkey : IComparable

 

See Also

<paramref> Tag | XML Comments