<var> (JavaScript)
Especifica la información de la documentación de una variable.
<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>
Parámetros
type
Opcional.Tipo de datos de la variable.El tipo puede ser:Un tipo de lenguaje ECMAScript que está 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 la variable es un entero.Establezca en true para indicar que la variable 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 de type tiene prioridad sobre este atributo.Este atributo especifica si la variable documentada es un elemento DOM.Establezca en true para especificar que la variable es un elemento DOM; si no, establezca en false.Si el atributo de type no se establece y domElement se establece en true, IntelliSense trata la variable documentada como HTMLElement al realizar el fragmento.mayBeNull
Opcional.Especifica si la variable documentada se puede establecer en null.Establezca en true para indicar que la variable 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 de 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 de elementType no se establece y elementDomElement se establece en true, IntelliSense trata cada elemento de la matriz como HTMLElement al realizar el fragmento.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 la variable.El identificador es o un id. 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 de <loc> (JavaScript) .description
Opcional.Una descripción de la variable.
Ejemplo
El ejemplo de código siguiente muestra cómo utilizar el elemento de <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;
}
}