<summary> (JavaScript)
関数またはメソッドの説明を指定します。
<summary locid="descriptionID">description
</summary>
パラメーター
locid
省略可能。関数またはメソッドに関するローカライズ情報用の識別子。この識別子は、メンバーの ID であるか、または OpenAjax のメタデータで定義されているメッセージ バンドル内の name 属性値に対応します。この識別子の型は、<loc> (JavaScript) 要素で指定された形式によって異なります。description
省略可能。関数またはメソッドの説明。
解説
<summary> (JavaScript)、<param> (JavaScript)、<returns> (JavaScript) など、関数の注釈に使用される要素は、ステートメントの前の関数本体に配置する必要があります。
使用例
次のコードに、<summary> 要素を使用する方法を示します。
function areaFunction(radiusParam)
{
/// <summary>Determines the area of a circle when supplied a radius parameter.</summary>
/// <param name="radiusParam" type="Number">The radius of the circle.</param>
/// <returns type="Number">The area.</returns>
var areaVal;
areaVal = Math.PI * radiusParam * radiusParam;
return areaVal;
}