<value> (Visual Basic)

Articolo
03/05/2013

Specifica la descrizione di una proprietà.

<value>property-description</value>

Parametri

property-description
Descrizione della proprietà.

Note

Il tag <value> consente di descrivere una proprietà.Tenere presente che l'aggiunta di una proprietà mediante la creazione guidata di codice nell'ambiente di sviluppo di Visual Studio determina l'aggiunta di un tag <summary> (Visual Basic) alla nuova proprietà.È quindi necessario aggiungere manualmente un tag <value> per descrivere il valore rappresentato dalla proprietà.

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

Esempio

Nell'esempio riportato di seguito il tag <value> viene utilizzato per descrivere il valore della 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