(Visual Basic)

Formats a word as a parameter.

Syntax

Parameters

name
The name of the parameter to refer to. Enclose the name in double quotation marks (" ").

Remarks

The tag gives you a way to indicate that a word is a parameter. The XML file can be processed to format this parameter in some distinct way.

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

Example

This example uses the tag to refer to 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