Adds a type parameter description to the type parameters section. This tag is only valid in VS 2005 and higher when used for generic member. Comment may contain any number of <typeparam> tags.
Syntax
<typeparam name="name">description</param>
where:
name
The name of a type parameter. Enclose the name in quotation marks (" ").
description
A description for the type parameter.
This tag is used in generic members when type arguments are used.
Examples
Visual Basic
|
 Copy Code
|
''' <summary>Represents a key-value pair which can be sorted.</summary>
''' <typeparam name="Tkey">Type of key which can be compared.</typeparam>
''' <typeparam name="Tvalue">Value type.</typeparam>
Public Class SortableKeyValuePair(Of Tkey As IComparable, Tvalue)
|
C#
|
Copy Code
|
/// <summary>Represents a key-value pair which can be sorted.</summary>
/// <typeparam name="Tkey">Type of key which can be compared.</typeparam>
/// <typeparam name="Tvalue">Value type.</typeparam>
public class SortableKeyValuePair<Tkey, Tvalue> where Tkey : IComparable
|
|
The text in bold is added automatically when using Add XML Comment from pop-up menu.
See Also
