<field> (JavaScript)
Especifica la información de la documentación, incluyendo una descripción, para un campo o miembro definidos en un objeto.
<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>
Parámetros
name
El nombre del campo o miembro.Cuando el elemento <field> se utiliza en una función constructora, name es obligatorio y define el miembro al que se aplica la etiqueta.Cuando el elemento <field> está anotando directamente un campo, se omite este atributo, y el nombre utilizado por Visual Studio es el nombre del campo real en el código fuente.static
Opcional.Especifica si el campo es un miembro de la función de constructor o un miembro del objeto devuelto por la función de constructor.Establezca en true para tratar el campo como miembro de la función de constructor.Establezca en false para tratar el campo como miembro del objeto devuelto por la función de constructor.type
Opcional.El tipo de datos de campo.El tipo puede ser:Un lenguaje ECMAScript escribe en la especificación de ECMAScript 5, como Number y Object.
Un objeto DOM, como HTMLElement, Window, y Document.
Una función constructora de JavaScript.
integer
Opcional.Si type es Number, especifica si el campo es un entero.Establezca en true para indicar que el campo es un entero; si no, establezca en false.Este atributo no se usa en Visual Studio para proporcionar información de IntelliSense.domElement
Opcional.Se deja de utilizar este atributo; el atributo type tiene prioridad sobre este atributo.Este atributo especifica si el campo documentado es un elemento DOM.Establezca en true para especificar que el campo es un elemento DOM; si no, establezca en false.Si el atributo type no se establece y domElement se establece en true, IntelliSense trata el campo documentado como HTMLElement al realizar la finalización de instrucciones.mayBeNull
Opcional.Especifica si el campo documentado se puede establecer en null.Establezca en true para indicar que el campo se puede establecer en null; si no, establezca en false.El valor predeterminado es false.Este atributo no se usa en Visual Studio para proporcionar información de IntelliSense.elementType
Opcional.Si type es Array, este atributo especifica el tipo de los elementos de la matriz.elementInteger
Opcional.Si type es Array y elementType es Number, este atributo especifica si los elementos de la matriz son enteros.Establezca en true para indicar que los elementos de la matriz son enteros; si no, establezca en false.Este atributo no se usa en Visual Studio para proporcionar información de IntelliSense.elementDomElement
Opcional.Se deja de utilizar este atributo; el atributo elementType tiene prioridad sobre este atributo.Si type es Array, este atributo especifica si los elementos de la matriz son elementos DOM.Establezca en true para especificar que los elementos son elementos DOM; si no, establezca en false.Si el atributo elementType no se establece y elementDomElement se establece en true, IntelliSense trata cada elemento de la matriz como HTMLElement al realizar la finalización de instrucciones.elementMayBeNull
Opcional.Si type es Array, especifique si los elementos de la matriz se pueden establecer en null.Establezca en true para indicar que los elementos de la matriz se pueden establecer en null; si no, establezca en false.El valor predeterminado es false.Este atributo no se usa en Visual Studio para proporcionar información de IntelliSense.helpKeyword
Opcional.La palabra clave de la ayuda de F1.locid
Opcional.El identificador para la información de localización sobre el campo.El identificador es o un identificador de miembro o corresponde a name el valor de atributo en empaquetar un de mensaje definido por los metadatos de OpenAjax.El tipo de identificador depende del formato especificado en la etiqueta <loc> (JavaScript) .value
Opcional.Especifica el código que se debe evaluar para uso de IntelliSense en lugar del propio código de la función.Para <field>, este atributo se admite para las funciones constructoras, pero no se admite para los literales de objeto.Puede utilizar este atributo debe proporcionar información de tipos cuando el tipo de campo es indefinido.Por ejemplo, puede utilizar value=’1’ para tratar el tipo de campo como un número.description
Opcional.Una descripción para el campo.
Comentarios
Se requiere el atributo name cuando se de un campo en una función constructora.Para el resto de los escenarios, todos los atributos del elemento <field> son opcionales.
Cuando se de una función constructora, el elemento <field> debe aparecer inmediatamente antes de la declaración de campo.El atributo name debe coincidir con el nombre de campo que se utiliza en el código fuente.Para los miembros del objeto, el atributo name puede omitir si el elemento <field> aparece inmediatamente antes de la declaración de miembro de objeto.
Ejemplo
El ejemplo de código siguiente muestra cómo utilizar el elemento <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;
}
El ejemplo siguiente se muestra cómo utilizar el elemento <field> con el atributo static establecido en 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.
El ejemplo siguiente se muestra cómo utilizar el elemento <field> con el atributo static establecido en 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.
El ejemplo siguiente se muestra cómo utilizar el elemento <field> con el atributo value .
function calculator(a) {
/// <field name='f' value='1'/>
}
new calculator().f. // Completion list for a Number.