<param> (JavaScript)
Spécifie les informations de documentation pour un paramètre dans une fonction ou une méthode.
<param name="parameterName" type="ParameterType" integer="true|false" domElement="true|false" mayBeNull="true|false" elementType="ArrayElementType" elementInteger="true|false" elementDomElement="true|false" elementMayBeNull="true|false" locid="descriptionID" parameterArray="true|false" optional="true|false" value="code">description</param>
Paramètres
name
Requis.Nom du paramètre.type
Optionnel.Type de données du paramètre.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 paramètre est un entier.Affectez à true pour indiquer que le paramètre 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 paramètre est documenté un élément DOM.Affectez à true pour spécifier que le paramètre 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 paramètre comme documenté HTMLElement en exécutant la saisie semi-automatique des instructions.mayBeNull
Optionnel.Spécifie si le paramètre documenté peut avoir la valeur null.Affectez à true pour indiquer que le paramètre 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.locid
Optionnel.L'identificateur pour les informations de localisation sur le paramètre.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 l'élément de <loc> (JavaScript) .parameterArray
Optionnel.Spécifie si le paramètre documenté peut être répété dans l'appel de fonction, semblable à répéter des paramètres pris en charge dans la fonction d' String.format .Affectez à true pour indiquer que le paramètre peut être répété ; sinon, affectez à false.Cet attribut n'est pas utilisé par Visual Studio pour fournir des informations Intellisense.optional
Optionnel.Spécifie si le paramètre facultatif est documenté dans l'appel de la fonction.Affectez à true pour indiquer que le paramètre est facultatif ; sinon, affectez à false.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.Vous pouvez utiliser cet attribut doit fournir des informations de type lorsque le type de paramètre n'est pas défini.Par exemple, vous pouvez utiliser value=’1’ pour traiter le type de paramètre comme un nombre.description
Optionnel.Une description du paramètre.
Notes
Le seul attribut requis est name.Tous les autres attributs sont facultatifs.
Les éléments utilisés pour annoter des fonctions, telles que <summary> (JavaScript), <param> (JavaScript), et <returns> (JavaScript), doivent être placés dans le corps de la fonction avant les instructions.
S'il existe plusieurs éléments d' <param> qui ont le même nom, l'un des éléments d' <param> est utilisé et les éléments redondants sont ignorés.Le comportement qui détermine quel élément est utilisé n'est pas défini.Si name fait référence à un paramètre inexistante, l'élément est ignoré.
Exemple
l'exemple de code suivant montre comment utiliser l'élément d' <param> .
function areaFunction(radiusParam)
{
/// <summary>Determines the area of a circle when provided a radius parameter.</summary>
/// <param name="radius" type="Number">The radius of the circle.</param>
/// <returns type="Number">The area.</returns>
var areaVal;
areaVal = Math.PI * radiusParam * radiusParam;
return areaVal;
}
// Uses of <param> with the value attribute.
function calculate(a) {
/// <param name='a' value='1'/>
a. // Completion list for a Number.
}
function calculate(a) {
/// <param name='a' value='{x:0,y:0}'/>
a. // x and y appear in the completion list.
}