Condividi tramite

<summary> (Visual Basic)

  • Articolo

Specifica il riepilogo del membro.

Sintassi

<summary>description</summary>

Parametri

description
Un riepilogo dell'oggetto.

Osservazioni:

Usare il tag <summary> per descrivere un tipo o un membro del tipo. Utilizzare <osservazioni> per aggiungere informazioni supplementari alla descrizione di un tipo.

Il testo del tag <summary> rappresenta l'unica fonte di informazioni sul tipo in IntelliSense e viene visualizzato anche 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 <summary> per descrivere il metodo ResetCounter e la proprietà Counter.

''' <summary>
''' Resets the value of the <c>Counter</c> field.
''' </summary>
Public Sub ResetCounter()
    counterValue = 0
End Sub
Private counterValue As Integer = 0
''' <summary>
''' Returns the number of times Counter was called.
''' </summary>
''' <value>Number of times Counter was called.</value>
Public ReadOnly Property Counter() As Integer
    Get
        counterValue += 1
        Return counterValue
    End Get
End Property

Vedi anche