@example【使用例】
@deprecated【非推奨】
@example【使用例】
メモ
- 使用例を記述
- 複数指定・複数行 可
- <caption>【表の見出し】 タグを最初に指定するとキャプション扱い
- 関連
構文
@example 使用例
例
/**
* 加算
* @param {number} x 加算値1
* @param {number} y 加算値2
* @return 合計値
*
* @example <caption>整数指定</caption>
* var z = Plus(1, 2);
* alert(z);
* // 3
*
* @example
* <caption>小数指定</caption>
* var z = Plus(1.2, 3.4);
* alert(z);
* // 4.6
*/
function Plus(x, y) {
return x + y;
}
@deprecated【非推奨】
メモ
構文
@deprecated [非推奨の説明]
@deprecated 非推奨の説明
例
/**
* 旧関数1
* @deprecated
*/
function funcOld1() { }
/**
* 旧関数2
* @deprecated ver. 2.0 以降
*/
function funcOld2() { }