<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 物件，例如、和 HTMLElementWindowDocument。
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.