Adds a parameter description to the parameters section. This is a top-level tag. A comment may contain any number of <param> tags.

Syntax

<param name="name">description</param>

where:

name

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

description

A description for the parameter.

This tag is used in a method, function, property or event comment when some arguments are used.

Examples

 

The text in bold is added automatically when using Add XML Comment from pop-up menu.

See Also