<value> (JavaScript)

指定的文档信息get和set ECMAScript 3 属性的功能。

<value type="ValueType" integer="true|false" domElement="true|false" mayBeNull="true|false" elementType="ArrayElementType" elementInteger="true|false" elementDomElement="true|false" elementMayBeNull="true|false" locid="descriptionID">description</value>

参数

  • type
    可选。 属性的数据类型。 类型可以是以下值之一:

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

    • A DOM object, such as HTMLElement, Window, and Document.

    • 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 或它对应于name属性在消息包定义的 OpenAjax 元数据中的值。 标识符类型取决于在指定的格式<loc> (JavaScript)元素。

  • description
    可选。 属性的说明。

备注

ECMAScript 5 属性使用<summary> (JavaScript)元素。

使用<value>元素的前面get或set函数。

示例

下面的代码示例演示如何使用<value>元素上的get函数。

    function Sys$CancelEventArgs$get_cancel() {
        /// <value type="Boolean" locid="P:J#Sys.CancelEventArgs.cancel"></value>
        if (arguments.length !== 0) throw Error.parameterCount();
        return this._cancel();
    }

请参见

概念

XML 文档注释 (JavaScript)