<field> (JavaScript)
为对象定义的字段或成员指定文档信息，包括说明。
<field name="fieldName" static="true|false" type="FieldType" integer="true|false" domElement="true|false" mayBeNull="true|false" elementType="ArrayElementType" elementInteger="true|false" elementDomElement="true|false" elementMayBeNull="true|false" helpKeyword="keyword" locid="descriptionID" value="code">description</field>
参数
name
字段或成员的名称。 当 <field> 元素用于构造函数时，需要 name 并定义标记应用的成员。 当 <field> 元素直接说明一个字段时，此属性将被忽略，并且，Visual Studio 使用的名称是实际字段的名称在源代码中。static
可选。 指定该字段是构造函数的成员或构造函数所返回对象的成员。 设置为 true 将字段作为构造函数的成员。 设置为 false 将字段，对象的成员由构造函数返回。type
可选。 字段的数据类型。 该类型可以是下列操作之一：ECMAScript 语言类型 ECMAScript 5 规范，如 Number 和 Object。
一个 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) 标记指定的格式。value
可选。 指定何时计算供 IntelliSense 而不是函数代码使用的代码。 对于 <field>，此属性为构造函数支持，但是，对于对象文本支持。 当字段类型是未定义时，可以使用此属性将提供类型信息。 例如，可以使用 value=’1’ 将字段类型作为数字。description
可选。 字段的说明。
备注
name 属性，当文档在构造函数时，的字段需要。 对于其他方案，<field> 元素的所有特性都是可选的。
在文档构造函数时，<field> 元素必须在字段声明前面。 name 特性必须与源代码的字段名称。 对于对象成员，因此，如果 <field> 元素在对象成员声明之前，显示 name 属性可以省略。
示例
下面的代码示例演示如何使用 <field> 元素。
// Use of <field> in an object definition.
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;
}
}
// Use of <field> in a constructor function.
// The name attribute is required.
function Engine() {
/// <field name='HorsePower' type='Number'>The engine's horsepower.</field>
this.HorsePower = 150;
}
下面的示例演示如何使用 static 属性的 <field> 元素设置为 true。
function Engine() {
/// <field name='HorsePower' static='true' type='Number'>static field desc.</field>
}
Engine.HorsePower = 140;
// IntelliSense on the field is available here.
Engine.
下面的示例演示如何使用 static 属性的 <field> 元素设置为 false。
function Engine() {
/// <field name='HorsePower' static='false' type='Number'>Non-static field desc.</field>
}
Engine.HorsePower = 140;
var eng = new Engine();
// IntelliSense on the field is available here.
eng.
下面的示例演示如何使用 value 属性的 <field> 元素。
function calculator(a) {
/// <field name='f' value='1'/>
}
new calculator().f. // Completion list for a Number.