<var> (JavaScript)
為變數指定文件資訊。
<var type="ValueType" integer="true|false" domElement="true|false" mayBeNull="true|false" elementType="ArrayElementType" elementInteger="true|false" elementDomElement="true|false" elementMayBeNull="true|false" helpKeyword="keyword" locid="descriptionID">description</var>
參數
type
選擇項。 變數的資料型別。 這個型別可以是下列其中一項:在 ECMAScript 5 規格，例如 Number 和 Object的 ECMAScript 語言類型。
一個 DOM 物件，例如 HTMLElement、 Window和 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 資訊。helpKeyword
選擇項。 F1 說明的關鍵字。locid
選擇項。 識別項對變數的當地語系化資訊。 此識別項或成員 ID 或其對應於 OpenAjax 中繼資料在訊息繫結的 name 屬性值所定義。 識別項的型別取決於 <loc> (JavaScript) 標記中指定的格式。description
選擇項。 變數的描述。
範例
下列程式碼範例會示範如何使用 <var> 項目。
/// <var>A rectangle that has a width of 5.</var>
var Rectangle = {
/// <field type = 'Number'>The width of the rectangle.</field>
wid: 5,
/// <field type = 'Number'>The length of the rectangle.</field>
len: 0,
/// <field type='Number'>Returns the area of the rectangle.</field>
getArea: function (wid, len) {
return len * wid;
}
}