Partilhar via

<observações> (Visual Basic)

  • Artigo

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

Sintaxe

<remarks>description</remarks>

Parâmetros

description
Uma descrição do membro.

Observações

Use a <remarks> tag para adicionar informações sobre um tipo, complementando as informações especificadas com <resumo>.

Essas informações aparecem no Pesquisador de objetos. Para obter informações sobre o Pesquisador de Objetos, consulte Exibindo a estrutura do código.

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

Exemplo

Este exemplo usa a <remarks> tag para explicar o que o UpdateRecord método 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