Condividi tramite

<remarks> (Visual Basic)

  • Articolo

Specifica una sezione relativa alle osservazioni per il membro.

<remarks>description</remarks>

Parametri

  • description
    Descrizione del membro.

Note

Il tag <remarks> viene utilizzato per aggiungere informazioni su un tipo, che integrano quelle specificate con <summary> (Visual Basic).

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

Eseguire la compilazione con /doc per elaborare in un file i commenti relativi alla documentazione.

Esempio

Nell'esempio riportato di seguito il tag <remarks> viene utilizzato per illustrare le operazioni che vengono eseguite dal 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

Vedere anche

Riferimenti

Tag XML consigliati per i commenti relativi alla documentazione (Visual Basic)