Adds a parameter description to the parameters section. A VSdocman comment may contain any number of @param tags. Equivalent XML tag is <param>.

Syntax

@param parameter-name description

The description may be continued on the next line. This tag is used in a method, function, property or event comment when some arguments are used.

Example:

    '**

    'Sample method with two arguments.
    '

    '@param        x The first parameter.

    '@param        y The second parameter.

    Function method1(ByVal x As Integer, ByVal y As String) As Boolean

See Also

<param> tag