<consulte> (Visual Basic)

  • Artículo

Especifica un vínculo a otro miembro.

Sintaxis

<see cref="member"/>

Parámetros

member
Referencia a un miembro o campo al cual se puede llamar desde el entorno de compilación actual. El compilador comprueba si el elemento de código dado existe y pasa member al nombre de elemento en el resultado XML. member debe aparecer entre comillas dobles (" ").

Comentarios

Use la etiqueta <see> para especificar un vínculo desde dentro del texto. Use <seealso> para indicar el texto que quiere que aparezca en una sección de tipo "Consulte también".

Compile con -doc para procesar los comentarios de documentación de un archivo.

Ejemplo

En este ejemplo se usa la etiqueta <see> de la sección de comentarios UpdateRecord para hacer referencia al 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

Consulte también