<var> (JavaScript)
Especifica informações sobre a documentação para uma variável.
<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.O tipo de dados da variável.O tipo pode ser um dos seguintes:Um tipo de linguagem ECMAScript que está na especificação de ECMAScript 5, como Number e Object.
Um objeto DOM, como HTMLElement, Window, e Document.
Uma função de construtor Javascript.
integer
Opcional.Se type é Number, especifica se a variável for um número inteiro.Defina a true para indicar que a variável é um inteiro; caso contrário, defina a false.Este atributo não é usado pelo Visual Studio para fornecer informações do IntelliSense.domElement
Opcional.Esse atributo é substituído; o atributo de type tem precedência sobre este atributo.Este atributo especifica se a variável documentado é um elemento DOM.Defina a true para especificar que a variável é um elemento DOM; caso contrário, defina a false.Se o atributo de type não está definido e domElement é definido como true, o IntelliSense trata a variável documentado como HTMLElement ao executar a conclusão da instrução.mayBeNull
Opcional.Especifica se a variável documentado pode ser definido como nulo.Defina a true para indicar que a variável pode ser definido como nulo; caso contrário, defina a false.o valor padrão é false.Este atributo não é usado pelo Visual Studio para fornecer informações do IntelliSense.elementType
Opcional.Se type é Array, este atributo especifica o tipo dos elementos da matriz.elementInteger
Opcional.Se type é Array e elementType é Number, esse atributo especifica se os elementos na matriz são números inteiros.Defina a true para indicar que os elementos na matriz são números inteiros; caso contrário, defina a false.Este atributo não é usado pelo Visual Studio para fornecer informações do IntelliSense.elementDomElement
Opcional.Esse atributo é substituído; o atributo de elementType tem precedência sobre este atributo.Se type é Array, esse atributo especifica se os elementos na matriz são elementos DOM.Defina a true para especificar que os elementos são elementos DOM; caso contrário, defina a false.Se o atributo de elementType não está definido e elementDomElement é definido como true, o IntelliSense trata cada elemento na matriz como HTMLElement ao executar a conclusão da instrução.elementMayBeNull
Opcional.Se type é Array, especifica se os elementos na matriz podem ser definidos como nulo.Defina a true para indicar que os elementos na matriz podem ser definidos como nulo; caso contrário, defina a false.o valor padrão é false.Este atributo não é usado pelo Visual Studio para fornecer informações do IntelliSense.helpKeyword
Opcional.A palavra-chave para F1 ajuda.locid
Opcional.O identificador para informações de localização na variável.O identificador é ou uma identificação do membro ou corresponde ao valor do atributo de name em um pacote de mensagem definida por metadados de OpenAjax.O tipo identificador depende de formato especificado na marca de <loc> (JavaScript) .description
Opcional.Uma descrição da variável.
Exemplo
O exemplo de código a seguir mostra como usar o 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;
}
}