Edit

(Visual Basic)

Specifies the description of a property.

Syntax

property-description

Parameters

property-description
A description for the property.

Remarks

Use the 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

tag for the new property. You should then manually add a tag to describe the value that the property represents.

Compile with -doc to process documentation comments to a file.

Example

This example uses the tag to describe what value the Counter property holds.

''' 
''' Resets the value of the Counter field.
''' 
Public Sub ResetCounter()
    counterValue = 0
End Sub
Private counterValue As Integer = 0
''' 
''' Returns the number of times Counter was called.
''' 
''' Number of times Counter was called.
Public ReadOnly Property Counter() As Integer
    Get
        counterValue += 1
        Return counterValue
    End Get
End Property

See also

  • Last updated on