<summary> (JavaScript)
関数またはメソッドの説明を指定します。
<summary locid="descriptionID">description</summary>
パラメーター
locid
省略可能です。ローカリゼーションの情報については、関数またはメソッドの識別子。識別子は、のいずれかのメンバーが ID またはそれに対応する、 name OpenAjax のメタデータで定義されている、メッセージ バンドル内の値の属性します。指定されている形式の識別子の種類によって異なります、 <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="radius" type="Number">The radius of the circle.</param>
/// <returns type="Number">The area.</returns>
var areaVal;
areaVal = Math.PI * radiusParam * radiusParam;
return areaVal;
}