<riepilogo> (Visual Basic)

Specifica il riepilogo del membro.

Sintassi

<summary>description</summary>  

Parametri

description
Riepilogo dell'oggetto.

Osservazioni:

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

Il testo per il <summary> tag è l'unica origine 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 della documentazione in un file.

Esempio

In questo esempio viene usato il <summary> tag per descrivere il metodo e Counter la ResetCounter proprietà .

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

Vedere anche

• Tag di commento XML