共用方式為


<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
    選擇項。 如需有關屬性的當地語系化資訊識別項。 識別項是成員,不論是哪一識別碼,或相對於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)