<summary> (Visual Basic)

Articolo
06/08/2015

Specifica il riepilogo del membro.

<summary>description</summary>

Parametri

description
Riepilogo relativo all'oggetto.

Note

Utilizzare il tag <summary> per descrivere un tipo o un membro di tipo. Utilizzare <remarks> (Visual Basic) per aggiungere informazioni supplementari alla descrizione di un tipo.

Il testo per il tag <summary> è l'unica fonte di informazioni sul tipo in IntelliSense e visualizza 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

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

''' <summary> 
''' Resets the value 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

Riferimenti

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

Condividi tramite