JSDocを使用する

@use JSDoc

同義語

emits

構文

@fires <className>#[event:]<eventName>

概要

@firesタグは、メソッドが呼び出されたときに、指定されたタイプのイベントを発行できることを示します。イベントの内容を表現するには@eventタグを使用してください。

例

'drain'というイベントを発行するメソッド

/**
 * Drink the milkshake.
 *
 * @fires Milkshake#drain
 */
Milkshake.prototype.drink = function() {
    // ...
};