@use JSDoc

同义词

语法

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

概述

@fires 标记表示在调用方法时,该方法可以触发指定类型的事件。使用 @event 标记 来记录事件的内容。

示例

触发“drain”事件的方法
/**
 * Drink the milkshake.
 *
 * @fires Milkshake#drain
 */
Milkshake.prototype.drink = function() {
    // ...
};