Compartir a través de

<remarks> (Visual Basic)

  • Artículo

Especifica una sección de comentarios para el miembro.

<remarks>description</remarks>

Parámetros

  • description
    Descripción del miembro.

Comentarios

Utilice la etiqueta <remarks> para agregar información sobre un tipo, complementando la información especificada con <summary> (Visual Basic).

Esta información aparece en el explorador de objetos. Para obtener información sobre el explorador de objetos, vea Ver la estructura del código.

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

Ejemplo

Este ejemplo utiliza la etiqueta <remarks> para explicar qué hace el 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

Vea también

Referencia

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