描述: 描述事件这个方法可能会触发。
别名:@emits
@fires <className>#[event:]<eventName>
@fires
标签标明当一个方法被调用时将触发一个指定类型的事件,使用@event 标签来描述事件的内容。
例如,方法将触发"drain"事件:
- /**
- * Drink the milkshake.
- *
- * @fires Milkshake#drain
- */
- Milkshake.prototype.drink = function() {
- // ...
- };