<see> (Visual Basic)

Especifica un vínculo a otro miembro.

<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

Utilice la etiqueta <see> para especificar un vínculo desde dentro del texto. Utilice <seealso> (Visual Basic) para indicar el texto que desea que aparezca en una sección "Vea también".

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

Ejemplo

Este ejemplo utiliza la etiqueta <see> en 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

Vea también

Referencia

Etiquetas XML recomendadas para comentarios de documentación (Visual Basic)