<value> (Visual Basic)

Article
06/08/2015

Spécifie la description d'une propriété.

<value>property-description</value>

Paramètres

property-description
Description de la propriété.

Notes

Utilisez la balise <value> pour décrire une propriété. Remarquez que lorsque vous ajoutez une propriété en utilisant l'Assistant Code dans l'environnement de développement Visual Studio .NET, une balise <summary> (Visual Basic) est ajoutée pour la nouvelle propriété. Vous devez ensuite ajouter manuellement une balise <value> pour décrire la valeur représentée par la propriété.

Compilez avec /doc pour traiter les commentaires de documentation et les placer dans un fichier.

Exemple

Cet exemple utilise la balise <value> pour décrire la valeur que contient la propriété 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

Voir aussi

Référence

Balises XML recommandées pour les commentaires de documentation (Visual Basic)

Partager via