<var> (JavaScript)
Spécifie les informations de documentation pour une 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>
Paramètres
type
Optionnel.Type de données de la variable.Le type peut être l'un des éléments suivants :Un type de langage ECMAScript qui est dans la spécification ECMAScript 5, tel qu' Number et Object.
Un objet DOM, tel qu' HTMLElement, Window, et Document.
Une fonction constructeur JavaScript.
integer
Optionnel.Si type est Number, spécifie si la variable est un entier.Affectez à true pour indiquer que la variable est un entier ; sinon, affectez à false.Cet attribut n'est pas utilisé par Visual Studio pour fournir des informations Intellisense.domElement
Optionnel.Cet attribut est déconseillé ; l'attribut d' type est prioritaire sur cet attribut.Cet attribut spécifie si la variable documentée est un élément DOM.Affectez à true pour spécifier que la variable est un élément DOM ; sinon, affectez à false.Si l'attribut d' type n'est pas défini et domElement a la valeur true, Intellisense traite la variable documentée comme HTMLElement en exécutant la saisie semi-automatique des instructions.mayBeNull
Optionnel.Spécifie si la variable documentée peut être la valeur null.Affectez à true pour indiquer que la variable peut être la valeur null ; sinon, affectez à false.La valeur par défaut est false.Cet attribut n'est pas utilisé par Visual Studio pour fournir des informations Intellisense.elementType
Optionnel.Si type est Array, cet attribut spécifie le type des éléments du tableau.elementInteger
Optionnel.Si type est Array et elementType est Number, cet attribut spécifie si les éléments du tableau sont des entiers.Affectez à true pour indiquer que les éléments du tableau sont des entiers ; sinon, affectez à false.Cet attribut n'est pas utilisé par Visual Studio pour fournir des informations Intellisense.elementDomElement
Optionnel.Cet attribut est déconseillé ; l'attribut d' elementType est prioritaire sur cet attribut.Si type est Array, cet attribut spécifie si les éléments du tableau sont des éléments DOM.Affectez à true pour spécifier que les éléments sont des éléments DOM ; sinon, affectez à false.Si l'attribut d' elementType n'est pas défini et elementDomElement a la valeur true, Intellisense traite chaque élément du tableau comme HTMLElement en exécutant la saisie semi-automatique des instructions.elementMayBeNull
Optionnel.Si type est Array, spécifie si les éléments du tableau peuvent être définis avec la valeur null.Affectez à true pour indiquer que les éléments du tableau peuvent être définis avec la valeur null ; sinon, affectez à false.La valeur par défaut est false.Cet attribut n'est pas utilisé par Visual Studio pour fournir des informations Intellisense.helpKeyword
Optionnel.Le mot clé pour obtenir de l'aide F1.locid
Optionnel.L'identificateur pour les informations de localisation sur la variable.L'identificateur est ou un ID membre ou il correspond à la valeur d'attribut d' name dans un à en-tête pack de message défini par les métadonnées d'OpenAjax.Le type d'identificateur dépend du format spécifié dans la balise de <loc> (JavaScript) .description
Optionnel.Une description de la variable.
Exemple
l'exemple de code suivant montre comment utiliser l'élément d' <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;
}
}