<returns> (JavaScript)
为函数的结果指定文档信息或方法调用。
<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>
参数
type
可选。 返回值的数据类型。 该类型可以是下列操作之一:ECMAScript语言类型ECMAScript 5规范，如 Number 和 Object。
一个DOM对象，例如 HTMLElement、Window和 Document。
JavaScript构造函数。
integer
可选。 如果 type 是 Number，指定返回值是整数。 设置为 true 指示返回值为整数，否则，将设置为 false。 Visual Studio不使用此属性提供IntelliSense信息。domElement
可选。 此属性已否决; type 属性优先于此属性。 此特性指定文档是否返回值是DOM元素。 设置为 true 指定返回值是DOM元素;否则，将设置为 false。 如果 type 未设置属性，并 domElement 设置为 true，IntelliSense将文档的返回值作为 HTMLElement，在执行语句完成。mayBeNull
可选。 指定文档是否返回值可以设置为null。 设置为 true 指示返回值可以设置为null;否则，将设置为 false。 默认值为 false。 Visual Studio不使用此属性提供IntelliSense信息。elementType
可选。 如果 type 是 Array，此属性在该数组指定元素的类型。elementInteger
可选。 如果 type 是 Array，并 elementType 是 Number，此属性指定该数组的元素是整数。 设置为 true 它表明数组中的元素是整数，否则，将设置为 false。 Visual Studio不使用此属性提供IntelliSense信息。elementDomElement
可选。 此属性已否决; elementType 属性优先于此属性。 如果 type 是 Array，此属性指定该数组的元素是否是DOM元素。 设置为 true 指定元素是DOM元素;否则，将设置为 false。 如果 elementType 未设置属性，并 elementDomElement 设置为 true，IntelliSense将数组的每个元素作为 HTMLElement，在执行语句完成。elementMayBeNull
可选。 如果 type 是 Array，指定该数组的元素是否可以设置为null。 设置为 true 它表明数组的元素可以设置为null;否则，将设置为 false。 默认值为 false。 Visual Studio不使用此属性提供IntelliSense信息。locid
可选。 标识符有关返回值的本地化信息。 该标识符是或成员ID或它对应于OpenAjax元数据在消息绑定的 name 属性值定义。 标识符类型取决于 <loc> (JavaScript) 标记指定的格式。value
可选。 指定何时计算供IntelliSense而不是函数代码使用的代码。 例如，可以使用此属性可为异步回调提供IntelliSense，例如 Promise。 使用 <returns> 元素的 value 属性可以通过使用长的代码执行IntelliSense提高性能。description
可选。 返回值的说明。
备注
在任何语句之前函数体必须将 <returns> 元素。
示例
下面的代码示例演示如何使用 <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.