@fires (synonyms: @emits)

.. @fires::

同义词

@emits

语法

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

概述

@fires标记表示方法在调用时可以触发指定类型的事件. 使用[@event标记] `event-tag <tags-event.html>`__来记录事件的内容.

示例

Method that fires a ‘drain’ event

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

.. @emits::

同义词

@fires