Share via

<osservazioni> (Visual Basic)

  • Articolo

Specifica una sezione osservazioni per il membro.

Sintassi

<remarks>description</remarks>

Parametri

description
Descrizione del membro.

Osservazioni:

Usare il tag <remarks> per aggiungere informazioni su un tipo, integrando le informazioni con <summary>.

Queste informazioni vengono visualizzate nel Visualizzatore oggetti. Per informazioni sul Visualizzatore oggetti, vedere Visualizzazione della struttura del codice.

Compilare con -doc per elaborare i commenti relativi alla documentazione in un file.

Esempio

In questo esempio viene usato il tag <remarks> per spiegare le operazioni del metodo 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

Vedi anche