Partilhar via

<consulte> (Visual Basic)

  • Artigo

Especifica um link para outro membro.

Sintaxe

<see cref="member"/>

Parâmetros

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

Observações

Use a <see> tag para especificar um link de dentro do texto. Use <seealso> para indicar o texto que você pode querer que apareça em uma seção "Consulte também".

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

Exemplo

Este exemplo usa a <see> tag na UpdateRecord seção de comentários para se referir ao DoesRecordExist método.

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

Consulte também