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>にテキストをラップすることにより、太字でそれを書くことができます。

を。

この答えが廃止されているが、それは私がそれを削除することはできません。

Answer 2

キーワードである @listensする

使用例：

/**
 * Outputs the event that happened
 *
 * @param {MyEvent} e - The observable event.
 * @listens MyEvent
 */
function myEventLogger(e) {
    console.log(e);
}

当然の結果である @fires のキーワードイベントを発生させるためます。