Partilhar via

< Consulte > (Visual Basic)

  • Artigo

Specifies a link to another member.

<see cref="member"/>

Parâmetros

  • member
    A reference to a member or field that is available to be called from the current compilation environment. O compilador verifica se o elemento de código fornecido existe e passa member para o nome do elemento na saída XML. memberdeve aparecer entre aspas duplas (" ").

Comentários

Use the <see> tag to specify a link from within text. Use <seealso> (Visual Basic) to indicate text that you might want to appear in a "See Also" section.

Compile with /doc to process documentation comments to a file.

Exemplo

This example uses the <see> tag in the UpdateRecord remarks section to refer to the DoesRecordExist method.

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