<field> (JavaScript)
Spécifie les informations de documentation, y compris une description, pour un champ ou le membre définis sur un objet.
<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>
Paramètres
name
Le nom du champ ou du membre.Lorsque l'élément d' <field> est utilisé dans une fonction constructeur, name est obligatoire et définit le membre auquel la balise applique.Lorsque l'élément d' <field> annote directement un champ, cet attribut est ignoré, et le nom utilisé par Visual Studio est le nom du champ réel dans le code source.static
Optionnel.Spécifie si le champ est membre de la fonction constructeur ou un membre de l'objet retourné par la fonction constructeur.Affectez à true pour traiter le champ comme membre de la fonction constructeur.Affectez à false pour traiter le champ comme un membre de l'objet retourné par la fonction constructeur.type
Optionnel.Le type de données du champ.Le type peut être l'un des éléments suivants :Un langage ECMAScript dans la norme ECMAScript 5, tel qu' Number et Object.
Le modèle DOM objet, comme HTMLElement, Window, et Document.
Une fonction constructeur JavaScript.
integer
Optionnel.Si type est Number, spécifie si le champ est un entier.Affectez à true pour indiquer que le champ 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 le champ est documenté un élément DOM.Affectez à true pour spécifier que le champ 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 le champ comme documenté HTMLElement en exécutant la saisie semi-automatique des instructions.mayBeNull
Optionnel.Spécifie si le champ documenté peut avoir la valeur null.Affectez à true pour indiquer que le champ peut avoir 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 le champ.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) .value
Optionnel.Spécifie le code qui doit être évaluée pour une utilisation par Intellisense au lieu du code de fonction elle-même.Pour <field>, cet attribut est pris en charge pour les fonctions constructeurs, mais n'est pas pris en charge pour les littéraux d'objet.Vous pouvez utiliser cet attribut doit fournir des informations de type lorsque le type de champ n'est pas défini.Par exemple, vous pouvez utiliser value=’1’ pour traiter le type de champ sous la forme d'un nombre.description
Optionnel.Une description pour le champ.
Notes
L'attribut d' name est requis lorsque vous documentez un champ dans une fonction constructeur.Pour tous les autres cas, tous les attributs de l'élément d' <field> sont facultatifs.
Lorsque vous documentez une fonction constructeur, l'élément d' <field> doit apparaître immédiatement avant la déclaration de champ.L'attribut d' name doit correspondre au nom de champ utilisé dans le code source.Pour les membres de l'objet, l'attribut d' name peut être omis si l'élément d' <field> apparaît immédiatement avant la déclaration de membre objet.
Exemple
l'exemple de code suivant montre comment utiliser l'élément d' <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;
}
L'exemple suivant indique comment utiliser l'élément d' <field> avec l'attribut d' static à 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.
L'exemple suivant indique comment utiliser l'élément d' <field> avec l'attribut d' static à 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.
L'exemple suivant indique comment utiliser l'élément d' <field> avec l'attribut d' value .
function calculator(a) {
/// <field name='f' value='1'/>
}
new calculator().f. // Completion list for a Number.