<typeparamref> (Visual Basic)

Formata uma palavra como um parâmetro type.

Sintaxe

<typeparamref name="name"/>  

Parâmetros

name: O nome do parâmetro type ao qual se referir. Coloque o nome entre aspas duplas (" ").

Observações

A <typeparamref> tag fornece uma maneira de indicar que uma palavra é um parâmetro type. O arquivo XML pode ser processado para formatar esse parâmetro de tipo de alguma forma distinta, por exemplo, em itálico.

Compile com -doc para processar comentários de documentação para um arquivo.

Example

Este exemplo usa a <typeparamref> tag para se referir ao T parâmetro type.

''' <summary>
''' Compares two items of type <typeparamref name="T"/>.
''' </summary>
''' <typeparam name="T">The type of items to compare.</typeparam>
''' <param name="item1">The first item of type <typeparamref name="T"/>.</param>
''' <param name="item2">The second item of type <typeparamref name="T"/>.</param>
''' <returns>True if the items are equal, False otherwise.</returns>
Public Function CompareItems(Of T As IComparable)(ByVal item1 As T, ByVal item2 As T) As Boolean
    Return item1.CompareTo(item2) = 0
End Function

Consulte também

• Tags de comentário XML