语法
¥Syntax
@listens <eventName>
概述
¥Overview
@listens 标记表示符号监听指定的事件。使用 @event 标签 记录事件的内容。
¥The @listens tag indicates that a symbol listens for the specified event. Use the
@event tag to document the event's content.
示例
¥Example
以下示例演示如何记录名为 module:hurler~event:snowball 的事件，以及监听该事件的名为 module:playground/monitor.reportThrowage 的方法。
¥The following example shows how to document an event named module:hurler~event:snowball, as well
as a method named module:playground/monitor.reportThrowage that listens for the event.
define('hurler', [], function () {
/**
* Event reporting that a snowball has been hurled.
* * @event module:hurler~snowball
* @property {number} velocity - The snowball's velocity, in meters per second.
*/
/**
* Snowball-hurling module.
* * @module hurler
*/
var exports = {
/**
* Attack an innocent (or guilty) person with a snowball.
* * @method
* @fires module:hurler~snowball
*/
attack: function () {
this.emit('snowball', { velocity: 10 });
}
};
return exports;
});
define('playground/monitor', [], function () {
/**
* Keeps an eye out for snowball-throwers.
* * @module playground/monitor
*/
var exports = {
/**
* Report the throwing of a snowball.
* * @method
* @param {module:hurler~event:snowball} e - A snowball event.
* @listens module:hurler~event:snowball
*/
reportThrowage: function (e) {
this.log('snowball thrown: velocity ' + e.velocity);
}
};
return exports;
});