<returns> (JavaScript)
Specifica le informazioni sulla documentazione relativa al risultato di una funzione o una chiamata al metodo.
<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>
Parametri
type
Opzionale.Il tipo di dati del valore restituito.Il tipo può essere:Un 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 il valore restituito è un Integer.Impostare su true per indicare che il valore restituito è 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 il valore restituito è documentato un elemento DOM.Impostare su true per specificare che il valore restituito è un elemento DOM; in caso contrario, insieme a false.Se l'attributo type non è impostato e domElement è impostato su true, IntelliSense considera il valore restituito come documentato HTMLElement durante il completamento delle istruzioni.mayBeNull
Opzionale.Specifica se il valore restituito documentato può essere impostato su null.Impostare su true per indicare che il valore restituito può essere impostato 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.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.locid
Opzionale.L'identificatore per informazioni sulla localizzazione sul valore restituito.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).value
Opzionale.Specifica il codice che deve essere valutato da IntelliSense anziché il codice della funzione.Ad esempio, è possibile utilizzare questo attributo per fornire IntelliSense per i callback asincrono, come Promise.Utilizzando l'attributo value con l'elemento <returns> può migliorare le prestazioni di IntelliSense omissione di lunga durata esecuzione di codice.description
Opzionale.Descrizione del valore restituito.
Note
L'elemento <returns> deve essere inserito nel corpo della funzione prima delle istruzioni.
Esempio
Le esempio di codice seguente viene illustrato come utilizzare l'elemento <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.