<see> (Visual Basic)

  • Artigo

Especifica um link para outro membro.

Sintaxe

<see cref="member"/>

Parâmetros

member
Uma referência a um membro ou campo disponível para ser chamado do ambiente de compilação atual. O compilador verifica se o elemento de código fornecido existe e passa member para o nome de elemento no XML de saída. member deve ser exibido entre aspas duplas (" ").

Comentários

Use a marca <see> para especificar um link de dentro do texto. Use <seealso> para indicar o texto que você deseja exibir em uma seção "Confira também".

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

Exemplo

Este exemplo usa a marca <see> na seção de comentários UpdateRecord para fazer referência ao método DoesRecordExist.

''' <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