<var> (JavaScript)
Specifica le informazioni sulla documentazione relativa a una variabile.
<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>
Parametri
type
Opzionale.Tipo di dati della variabile.Il tipo può essere:Un tipo di linguaggio ECMAScript nella specifica di ECMAScript 5, come Number e Object.
Un oggetto DOM, come HTMLElement, Windowe Document.
Una funzione costruttore JavaScript.
integer
Opzionale.Se type è Number, specifica se la variabile è un Integer.Impostare su true per indicare che la variabile è un Integer, in caso contrario, insieme a false.Questo attributo non viene utilizzato da Visual Studio per fornire informazioni di IntelliSense.domElement
Opzionale.Questo attributo è stato deprecato; l'attributo type ha la precedenza su questo attributo.Questo attributo specifica se la variabile viene illustrato un elemento DOM.Impostare su true per specificare che la variabile è un elemento DOM; in caso contrario, insieme a false.Se l'attributo type non è impostato e domElement è impostato su true, IntelliSense nella variabile illustrato come HTMLElement durante il completamento delle istruzioni.mayBeNull
Opzionale.Specifica se la variabile documentata può essere impostata su null.Impostare su true per indicare che la variabile può essere impostata per annullare; in caso contrario, insieme a false.Il valore predefinito è false.Questo attributo non viene utilizzato da Visual Studio per fornire informazioni di IntelliSense.elementType
Opzionale.Se type è Array, questo attributo specifica il tipo degli elementi nella matrice.elementInteger
Opzionale.Se type è Array e elementType è Number, questo attributo consente di specificare se gli elementi nella matrice di Integer.Impostare su true per indicare che gli elementi nella matrice di Integer, in caso contrario, insieme a false.Questo attributo non viene utilizzato da Visual Studio per fornire informazioni di IntelliSense.elementDomElement
Opzionale.Questo attributo è stato deprecato; l'attributo elementType ha la precedenza su questo attributo.Se type è Array, questo attributo consente di specificare se gli elementi nella matrice sono elementi DOM.Impostare su true per specificare che gli elementi sono elementi DOM, in caso contrario, insieme a false.Se l'attributo elementType non è impostato e elementDomElement è impostato su true, IntelliSense considera ogni elemento della matrice come HTMLElement durante il completamento delle istruzioni.elementMayBeNull
Opzionale.Se type è Array, specifica se gli elementi nella matrice possono essere impostati su null.Impostare su true per indicare che gli elementi nella matrice possono essere impostati su null; in caso contrario, insieme a false.Il valore predefinito è false.Questo attributo non viene utilizzato da Visual Studio per fornire informazioni di IntelliSense.helpKeyword
Opzionale.La parola chiave della Guida.locid
Opzionale.L'identificatore per informazioni sulla localizzazione sulla variabile.L'identificatore è un membro o ID o corrisponde al valore di attributo name in un gruppo di messaggio definito dai metadati di OpenAjax.Il tipo dell'identificatore dipende dal formato specificato nel tag <loc> (JavaScript).description
Opzionale.Una descrizione della variabile.
Esempio
Le esempio di codice seguente viene illustrato come utilizzare l'elemento <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;
}
}