javascript - JSDocでイベントハンドラーを文書化する方法は？

Question

次のようなクラスがあるとします。

function myClass(q) {
  this.someFunction = function(e) {
      console.log("Click event");
  };

  jQuery(q).click(this.someFunction);
}

someFunctionが直接呼び出される関数ではなく、イベントハンドラーであることをJSDocに示す方法はありますか？

@eventタグが表示されますが、正しく理解していれば、これは、イベントハンドラーではなく、イベント（クライアントコードも登録され、必要に応じてクラスが起動するもの）と見なすクラス内の関数を文書化するためのものです。働き ？

Answer 1

いいえ、イベント ハンドラーを文書化する方法はありません。

したがって、最善の方法は、通常の関数として文書化することです。おそらく、その説明を太字または大文字で記述し、それを「イベント ハンドラ」とします。

おそらくすでにこれを行っていると思いますが、念のため: テキストを html タグで囲むだけで、太字で書くことができます<strong></strong>。

この回答は廃止されましたが、削除することはできません。