<param> (JavaScript)

指定参数的文档信息在函数或方法。

<param name="parameterName" type="ParameterType" integer="true|false" domElement="true|false" mayBeNull="true|false" elementType="ArrayElementType" elementInteger="true|false" elementDomElement="true|false" elementMayBeNull="true|false" locid="descriptionID" parameterArray="true|false" optional="true|false" value="code">description</param>

参数

  • name
    必需。 参数的名称。

  • type
    可选。 参数的数据类型。 该类型可以是下列操作之一:

    • ECMAScript 语言类型 ECMAScript 5 规范,如 NumberObject

    • 一个 DOM 对象,例如 HTMLElementWindowDocument

    • JavaScript 构造函数。

  • integer
    可选。 如果 type 是 Number,指定参数是否是整数。 设置为 true 指示该参数是整数,否则,将设置为 false。 Visual Studio 不使用此属性提供 IntelliSense 信息。

  • domElement
    可选。 此属性已否决;type 属性优先于此属性。 此特性指定将文档的参数是否是 DOM 元素。 设置为 true 指定参数是 DOM 元素;否则,将设置为 false。 如果 type 未设置属性,并 domElement 设置为 true,IntelliSense 将文档的参数作为 HTMLElement,在执行语句完成。

  • mayBeNull
    可选。 指定该文档的参数是否可以设置为 null。 设置为 true 指示该参数可设置为 null;否则,将设置为 false。 默认值为 false。 Visual Studio 不使用此属性提供 IntelliSense 信息。

  • elementType
    可选。 如果 type 是 Array,此属性在该数组指定元素的类型。

  • elementInteger
    可选。 如果 type 是 Array,并 elementType 是 Number,此属性指定该数组的元素是整数。 设置为 true 它表明数组中的元素是整数,否则,将设置为 false。 Visual Studio 不使用此属性提供 IntelliSense 信息。

  • elementDomElement
    可选。 此属性已否决;elementType 属性优先于此属性。 如果 type 是 Array,此属性指定该数组的元素是否是 DOM 元素。 设置为 true 指定元素是 DOM 元素;否则,将设置为 false。 如果 elementType 未设置属性,并 elementDomElement 设置为 true,IntelliSense 将数组的每个元素作为 HTMLElement,在执行语句完成。

  • elementMayBeNull
    可选。 如果 type 是 Array,指定该数组的元素是否可以设置为 null。 设置为 true 它表明数组的元素可以设置为 null;否则,将设置为 false。 默认值为 false。 Visual Studio 不使用此属性提供 IntelliSense 信息。

  • locid
    可选。 标识符有关参数的本地化信息。 该标识符是或成员 ID 或它对应于 OpenAjax 元数据在消息绑定的 name 属性值定义。 标识符类型取决于 <loc> (JavaScript) 元素指定的格式。

  • parameterArray
    可选。 指定该文档的参数是否在可以重复的函数调用,类似于循环访问 String.format 功能支持的参数。 设置为 true 指示该参数可以重复使用;否则,将设置为 false。 Visual Studio 不使用此属性提供 IntelliSense 信息。

  • optional
    可选。 指定该文档的参数是否可选在调用函数。 设置为 true 指示该参数是可选的;否则,将设置为 false。

  • value
    可选。 指定何时计算供 IntelliSense 而不是函数代码使用的代码。 当参数类型是未定义时,可以使用此属性将提供类型信息。 例如,可以使用 value=’1’ 将参数类型为数字。

  • description
    可选。 参数的说明。

备注

唯一的必选特性。name。 其他属性是可选的。

在任何语句之前函数体必须将用于的元素来批注函数,如 <summary> (JavaScript)<param> (JavaScript)<returns> (JavaScript)

如果有多个同名的 <param> 元素,使用一个 <param> 元素,并冗余元素将被忽略。 定位行为使用哪个元素未定义。 如果 name 引用了不存在的参数,元素被忽略。

示例

下面的代码示例演示如何使用 <param> 元素。

function areaFunction(radiusParam)
{
    /// <summary>Determines the area of a circle when provided a radius parameter.</summary>
    /// <param name="radius" type="Number">The radius of the circle.</param>
    /// <returns type="Number">The area.</returns>
    var areaVal;
    areaVal = Math.PI * radiusParam * radiusParam;
    return areaVal;
}

// Uses of <param> with the value attribute.

function calculate(a) {
    /// <param name='a' value='1'/>
    a.    // Completion list for a Number.
}

function calculate(a) {
    /// <param name='a' value='{x:0,y:0}'/>
    a.    // x and y appear in the completion list.
}

请参见

概念

XML 文档注释 (JavaScript)