(Visual Basic)

Defines a parameter name and description.

Syntax

description  

Parameters

name
The name of a method parameter. Enclose the name in double quotation marks (" ").

description
A description for the parameter.

Remarks

The tag should be used in the comment for a method declaration to describe one of the parameters for the method.

The text for the tag will appear in the following locations:

• Parameter Info of IntelliSense. For more information, see Using IntelliSense.

• Object Browser. For more information, see Viewing the Structure of Code.

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

Example

This example uses the tag to describe the id parameter.

''' The ID of the record to update.
''' Updates the record .
''' Use  to verify that
''' the record exists before calling this method.
''' 
Public Sub UpdateRecord(ByVal id As Integer)
    ' Code goes here.
End Sub
''' The ID of the record to check.
''' True if  exists,
''' False otherwise.
''' 
Public Function DoesRecordExist(ByVal id As Integer) As Boolean
    ' Code goes here.
End Function

See also

• XML Comment Tags