Specifies the description of a property.
<value>property-description</value>
Parameters
- property-description
A description for the property.
Remarks
Use the <value> tag to describe a property. Note that when you add a property using the code wizard in the Visual Studio development environment, it will add a <summary> (Visual Basic) tag for the new property. You should then manually add a <value> tag to describe the value that the property represents.
Compile with /doc to process documentation comments to a file.
Example
This example uses the <value> tag to describe what value the Counter property holds.
''' <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
See Also
Reference
Recommended XML Tags for Documentation Comments (Visual Basic)