Compartilhar via

<seealso> (Visual Basic)

  • Artigo

Especifica um link que aparece na seção Consulte Também.

<seealso cref="member"/>

Parâmetros

  • member
    Uma referência a um membro ou campo que está disponível para ser chamado a partir do 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.memberdeve aparecer entre aspas duplas ("").

Comentários

Use a marca <seealso> para especificar o texto que você deseja que apareça em uma seção Consulte Também.Use <see> (Visual Basic) para especificar um link de dentro do texto.

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

Exemplo

Este exemplo usa a marca <seealso> na seção comentários DoesRecordExist para referir-se ao método UpdateRecord.

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

Referência

Recomendado marcas XML para comentários da documentação (Visual Basic)