<typeparam> (Visual Basic)

  • Article

Defines a type parameter name and description.

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

Parameters

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

  • description
    A description of the type parameter.

Remarks

Use the <typeparam> tag in the comment for a generic type or generic member declaration to describe one of the type parameters.

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

Example

This example uses the <typeparam> tag to describe the id parameter.

''' <typeparam name="T"> 
''' The base item type. Must implement IComparable. 
''' </typeparam> 
Public Class itemManager(Of T As IComparable)
    ' Insert code that defines class members. 
End Class

See Also

Reference

Recommended XML Tags for Documentation Comments (Visual Basic)