< > comentarios (Visual Basic)

Especifica una sección de comentarios para el miembro.

Sintaxis

<remarks>description</remarks>  

Parámetros

description
Descripción del miembro.

Observaciones

Use la <remarks> etiqueta para agregar información sobre un tipo, complementando la información especificada con <resumen>.

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

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

Ejemplo

En este ejemplo se usa la <remarks> etiqueta para explicar lo que hace el UpdateRecord método.

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

• Etiquetas de comentario XML