<remarks> (Visual Basic)

  • Artigo

Especifica uma seção comentários para o membro.

<remarks>description</remarks>

Parâmetros

  • description
    Uma descrição do membro.

Comentários

Use a marca de <remarks> para adicionar informações sobre um tipo, suplementando informações especificada com <summary> (Visual Basic).

Essa informação aparece no pesquisador de objetos.Para obter informações sobre o pesquisador de objetos, consulte Exibindo a estrutura de código.

Compile com /doc para processar comentários de documentação a um arquivo.

Exemplo

este exemplo usa a marca de <remarks> para explicar o que o método de UpdateRecord faz.

''' <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 também

Referência

Recomendado marcas XML para comentários da documentação (Visual Basic)