jQueryのコメントをどのように書かれていますか？

Question

一般的に関数にコメントを付与する場合は、以下のような書き方が多い気がします。

/**
 * [test description]
 * @param  {[type]} str [description]
 * @param  {[type]} num [description]
 * @return {[type]}     [description]
 */
function test( str, num ) {
}

jQueryのような引数や戻り値を伴わない処理ではどのようにコメントを書かれていますか？
(もちろんコメントを付与しなくても理解可能なコードを書くのがベストですが...)

$(function(){
  $('#test').on("change", function () {
    ~~~
  });
});

みなさんのご意見をお聞きしたいです。

Comments

[Lhankor_Mhy]

匿名関数は他から呼ばれる可能性がないと思いますが……

[m.ts10806]

JSDocの話ならルールなので、ルールに従う、決める、好きにやる
だけではないでしょうか。

Answer 1

jQueryは平文ではただのjsですから好きに書けばよいと思います
セレクタの直前にイベントごとの詳細をつけるか
イベントのコールバック内に適当にかいておけばよいでしょう