JSDoc中文文档(@use JSDoc)

JSDoc @fires 标签

目录

同义词

JSDoc @emits 标签

语法

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

概述

@fires标签标明当一个方法被调用时将触发一个指定类型的事件，使用@event 标签来描述事件的内容。

示例

示例: 方法将触发"drain"事件
/**
 * Drink the milkshake.
 *
 * @fires Milkshake#drain
 */
Milkshake.prototype.drink = function() {
    // ...
};