<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;
}
}