<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 の Number と Objectなどの ECMAScript 5 の仕様を、言語。

  • HTMLElement、Windowと Documentなどの DOM オブジェクト。

  • JavaScript のコンストラクター関数。

• integer
  省略可能。type が Numberの場合、戻り値が整数であるかどうかを指定します。戻り値が整数であることを示すに true に設定します; それ以外 falseに設定します。Visual Studio には、この属性が IntelliSense 情報を提供するためには使用されません。

• domElement
  省略可能。この属性は避けてください; type の属性がこの属性より優先されます。この属性は、非公開の戻り値が DOM 要素であるかどうかを指定します。戻り値が DOM 要素であることを指定するに true に設定します; それ以外 falseに設定します。type の属性が設定されていない場合、domElementtrueがに設定されている場合、IntelliSense、ステートメント入力候補を実行するとき HTMLElement として記述される戻り値を処理します。

• mayBeNull
  省略可能。非公開の戻り値を null に設定できるかどうかを指定します。戻り値が null に設定できることを示すために true に設定します; それ以外 falseに設定します。既定値 false です。Visual Studio には、この属性が IntelliSense 情報を提供するためには使用されません。

• elementType
  省略可能。type が Arrayの場合、この属性は配列の要素の型を指定します。

• elementInteger
  省略可能。type が Array 場合、elementType が Numberの場合、この属性は配列の要素が整数であるかどうかを指定します。配列の要素が整数であることを示すために true に設定します; それ以外 falseに設定します。Visual Studio には、この属性が IntelliSense 情報を提供するためには使用されません。

• elementDomElement
  省略可能。この属性は避けてください; elementType の属性がこの属性より優先されます。type が Arrayの場合、この属性は配列の要素が DOM 要素であるかどうかを指定します。要素が DOM 要素であることを指定するに true に設定します; それ以外 falseに設定します。elementType の属性が設定されていない場合、elementDomElementtrueがに設定されている場合、IntelliSense は HTMLElement として、ステートメント入力候補を実行するときに配列の各要素を処理します。

• elementMayBeNull
  省略可能。type が Array場合、配列の要素が null に設定できるかどうかを指定します。配列の要素が null に設定できることを示すために true に設定します; それ以外 falseに設定します。既定値 false です。Visual Studio には、この属性が IntelliSense 情報を提供するためには使用されません。

• locid
  省略可能。戻り値に関する情報のローカリゼーションの識別子。この識別子は、メンバーの ID であるか、または OpenAjax のメタデータで定義されているメッセージのバンドルの name の属性値に対応します。識別子の型は <loc> (JavaScript) のタグで指定されている形式によって異なります。

• value
  省略可能。関数コードではなく、IntelliSense によって評価自体に対して使用する必要のあるコードを指定します。たとえば、Promiseのような非同期コールバックに IntelliSense を提供するために、この属性を使用できます。<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.

参照

概念

XML ドキュメント コメント (JavaScript)