<returns> (JavaScript)

Article
03/04/2013

Spécifie les informations de documentation pour le résultat d'une fonction ou d'un appel de méthode.

<returns type="ValueType" integer="true|false" domElement="true|false" mayBeNull="true|false" elementType="ArrayElementType" elementInteger="true|false" elementDomElement="true|false" elementMayBeNull="true|false" locid="descriptionID" value="code">description</returns>

Paramètres

type
Optionnel.Le type de données de la valeur de retour.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 la valeur de retour est un entier.Affectez à true pour indiquer que la valeur de retour 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 valeur de retour documentée est un élément DOM.Affectez à true pour spécifier que la valeur de retour 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 valeur de retour documentée comme HTMLElement en exécutant la saisie semi-automatique des instructions.
mayBeNull
Optionnel.Spécifie si la valeur de retour documentée peut être la valeur null.Affectez à true pour indiquer que la valeur de retour 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.
locid
Optionnel.L'identificateur pour les informations de localisation sur la valeur de retour.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.Par exemple, vous pouvez utiliser cet attribut pour fournir Intellisense pour les rappels asynchrones, telles que Promise.À l'aide de l'attribut d' value à l'élément d' <returns> peut améliorer les performances d'Intellisense en contournant l'opération de longue code.
description
Optionnel.Description de la valeur retournée.

Notes

L'élément d' <returns> doit être placé dans le corps de la fonction avant les instructions.

Exemple

l'exemple de code suivant montre comment utiliser l'élément d' <returns> .

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;
}

// The following examples use the <remarks> element with a value attribute.

function getJson(complete) { 
    /// <returns value='complete("")' ></returns>
    var r = new XMLHttpRequest(); 
    // . . . 
} 

getJson(function (json) { 
    json.  // IntelliSense for a String object is 
           // available here.
});

function calculate(x) {
    /// <returns value='1'/>
}
calculate().  // Completion list for a Number.

Voir aussi

Concepts

Commentaires de documentation XML (JavaScript)

Partager via