This is old and not recommended tag. It adds an argument settings to the settings section. A VSdocman comment may contain any number of <set> tags.

Syntax

<set param="parameter-name" const="constant-name" value="constant-value">constant-description</set>

parameter-name ... name of an argument for which the value setting is described.

constant-name ... argument value name.

constant-value ... argument value. XML doesn't allow to use double quotes in attribute values. Therefore, if your constant is of type String, you must use apostrophe ' or &quot; instead of ".

constant-description ... description of that value.

Usually there is no need for this tag because you should use enumerations as parameter types in such cases. This tag is used in a method, function, property or event comment when some arguments are used. It describes possible setting for specified parameter. Every possible value requires one <set> tag. Only 3 arguments per comment block can have specified settings, others are ignored. You can describe settings for arguments you want (e.g. arg1, arg3, arg6 in parameter-name field). If after them compiler encounters <set> tag with parameter-name=arg2, this tag is ignored.

Examples

Visual Basic

Copy CodeCopy Code

''' <summary>Our sample method.</summary>

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

''' <set param="x" const="c1" value="1">first constant</set>

''' <set param="x" const="c2" value="34">second constant</set>

''' <returns>True if no error occurs.</returns>

Function method1(ByVal x As Integer) As Boolean

C#

Copy CodeCopy Code

/// <summary>Our sample method.</summary>

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

/// <set param="x" const="c1" value="1">first constant</set>

/// <set param="x" const="c2" value="34">second constant</set>

/// <returns>True if no error occurs.</returns>

public bool method1(int x)

 

See Also