@use JSDoc

同義字

語法

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

概觀

@fires 標籤表示當呼叫方法時,該方法可以觸發指定類型的事件。使用 @event 標籤 來記錄事件的內容。

範例

觸發「drain」事件的方法
/**
 * Drink the milkshake.
 *
 * @fires Milkshake#drain
 */
Milkshake.prototype.drink = function() {
    // ...
};