<returns> (JavaScript)
Especifica la información de la documentación del resultado de una función o una llamada al método.
<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>
Parámetros
type
Opcional.El tipo de datos del valor devuelto.El tipo puede ser:Un lenguaje ECMAScript escribe en la especificación de ECMAScript 5, como Number y Object.
Un objeto DOM, como HTMLElement, Window, y Document.
Una función constructora de JavaScript.
integer
Opcional.Si type es Number, especifica si el valor devuelto es un entero.Establezca en true para indicar que el valor devuelto es un entero; si no, establezca en false.Este atributo no se usa en Visual Studio para proporcionar información de IntelliSense.domElement
Opcional.Se deja de utilizar este atributo; el atributo de type tiene prioridad sobre este atributo.Este atributo especifica si el valor devuelto documentado es un elemento DOM.Establezca en true para especificar que el valor devuelto es un elemento DOM; si no, establezca en false.Si el atributo de type no se establece y domElement se establece en true, IntelliSense trata el valor devuelto documentado como HTMLElement al realizar el fragmento.mayBeNull
Opcional.Especifica si el valor devuelto documentado se puede establecer en null.Establezca en true para indicar que el valor devuelto se puede establecer en null; si no, establezca en false.El valor predeterminado es false.Este atributo no se usa en Visual Studio para proporcionar información de IntelliSense.elementType
Opcional.Si type es Array, este atributo especifica el tipo de los elementos de la matriz.elementInteger
Opcional.Si type es Array y elementType es Number, este atributo especifica si los elementos de la matriz son enteros.Establezca en true para indicar que los elementos de la matriz son enteros; si no, establezca en false.Este atributo no se usa en Visual Studio para proporcionar información de IntelliSense.elementDomElement
Opcional.Se deja de utilizar este atributo; el atributo de elementType tiene prioridad sobre este atributo.Si type es Array, este atributo especifica si los elementos de la matriz son elementos DOM.Establezca en true para especificar que los elementos son elementos DOM; si no, establezca en false.Si el atributo de elementType no se establece y elementDomElement se establece en true, IntelliSense trata cada elemento de la matriz como HTMLElement al realizar el fragmento.elementMayBeNull
Opcional.Si type es Array, especifique si los elementos de la matriz se pueden establecer en null.Establezca en true para indicar que los elementos de la matriz se pueden establecer en null; si no, establezca en false.El valor predeterminado es false.Este atributo no se usa en Visual Studio para proporcionar información de IntelliSense.locid
Opcional.El identificador para la información de localización sobre el valor devuelto.El identificador es o un id. de miembro o corresponde a name el valor de atributo en empaquetar un de mensaje definido por los metadatos de OpenAjax.El tipo de identificador depende del formato especificado en la etiqueta de <loc> (JavaScript) .value
Opcional.Especifica el código que se debe evaluar para uso de IntelliSense en lugar del propio código de la función.Por ejemplo, puede utilizar este atributo para proporcionar IntelliSense para las devoluciones de llamada asincrónicos, como Promise.Utilizando el atributo de value con el elemento de <returns> puede mejorar el rendimiento de IntelliSense omitiendo la ejecución larga de código.description
Opcional.Descripción del valor devuelto.
Comentarios
El elemento de <returns> debe colocarse en el cuerpo de la función antes de cualquier fragmento.
Ejemplo
El ejemplo de código siguiente muestra cómo utilizar el elemento de <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.