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

Visual Basic

Copy CodeCopy Code

''' <summary>Sample method with two arguments.</summary>

''' <param name="x">The first parameter.</param>

''' <param name="y">The second parameter.</param>

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

C#

Copy CodeCopy Code

/// <summary>Sample method with two arguments.</summary>

/// <param name="x">The first parameter.</param>

/// <param name="y">The second parameter.</param>

public bool method1(int x, string y)

 

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

See Also

<typeparam> tag