Condividi tramite

<returns> (Visual Basic)

  • Articolo

Specifica il valore restituito della proprietà o della funzione.

<returns>description</returns>

Parametri

  • description
    Descrizione del valore restituito.

Note

Utilizzare il tag <returns> nel commento della dichiarazione di un metodo per descrivere il valore restituito.

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

Esempio

Nell'esempio riportato di seguito il tag <returns> viene utilizzato per illustrare i valori restituiti dalla funzione DoesRecordExist.

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