Compartir a través de

<remarks> (Visual Basic)

  • Artículo

Especifica una sección de comentarios para el miembro.

Sintaxis

<remarks>description</remarks>

Parámetros

description
Descripción del miembro.

Comentarios

La etiqueta <remarks> se usa para agregar información sobre un tipo y complementa la información especificada con <summary>.

Toda esta información aparece en el Examinador de objetos. Para más información sobre el Examinador de objetos, consulte Ver la estructura del código.

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

Ejemplo

En este ejemplo se usa la etiqueta <remarks> para explicar lo que 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

Consulte también