<paramref> (Visual Basic)
Formata uma palavra como um parâmetro.
Sintaxe
<paramref name="name"/>
Parâmetros
name
O nome do parâmetro ao qual você deseja se referir. Coloque o nome entre aspas duplas (" ").
Comentários
A marca <paramref>
fornece uma forma de indicar que uma palavra é um parâmetro. O arquivo XML pode ser processado para formatar esse parâmetro de uma forma distinta.
Compile com -doc para processar comentários de documentação em um arquivo.
Exemplo
Este exemplo usa a marca <paramref>
para se referir ao parâmetro id
.
''' <param name="id">The ID of the record to update.</param>
''' <remarks>Updates the record <paramref name="id"/>.
''' <para>Use <see cref="DoesRecordExist"/> to verify that
''' the record exists before calling this method.</para>
''' </remarks>
Public Sub UpdateRecord(ByVal id As Integer)
' Code goes here.
End Sub
''' <param name="id">The ID of the record to check.</param>
''' <returns><c>True</c> if <paramref name="id"/> exists,
''' <c>False</c> otherwise.</returns>
''' <remarks><seealso cref="UpdateRecord"/></remarks>
Public Function DoesRecordExist(ByVal id As Integer) As Boolean
' Code goes here.
End Function
Confira também
Colaborar conosco no GitHub
A fonte deste conteúdo pode ser encontrada no GitHub, onde você também pode criar e revisar problemas e solicitações de pull. Para obter mais informações, confira o nosso guia para colaboradores.