JS Docの書き方
JavaDocのJavaScript版、JS Docの書き方メモ。ドキュメントにしない場合も、自分のコードで何やったかってすぐ忘れるのでなるべく書いておきたい。
/**
* 数値に1を加算して返す。
* @param {Number} num 数値
* @returns {Number} 引数で与えられた数値に1を加算した数値
*/
function incrementNum(num){
return num + 1;
}
[参考]JsDoc Toolkitを使う!:http://www12.atwiki.jp/aias-jsdoctoolkit/