如何记录所发出的事件stream返回于MyFunc()与 JSDoc？
/**
* [MyFunc description]
* @param {Object} opts - [description]
* @return {Stream} - [description]
*/
function MyFunc (opts) {
// stream is an EventEmitter
var stream = new MyEventEmitter();
stream.emit('event1', ... );
stream.emit('event2', ... );
return stream;
}
您可以通过记录您的事件来记录这些行为（event1, event2， ...） 作为@event MyFunc#event1和 MyFunc，或者任何发出信号的人，@fires MyFunc#event1.
您还可以记录监听这些事件的函数@listens MyFunc#event:event1.
以下是上述标签的官方 JSDoc 页面：
- https://jsdoc.app/tags-event.html https://jsdoc.app/tags-event.html
- https://jsdoc.app/tags-fires.html https://jsdoc.app/tags-fires.html
- https://jsdoc.app/tags-listens.html https://jsdoc.app/tags-listens.html
请注意标签事件页面中提到的“事件”的一些细微差别，在此重复：
JSDoc 自动在前面添加名称空间event:每个事件的名称。通常，当链接到另一个 doclet 中的事件时，必须包含此命名空间。 （这@fires标签是一个值得注意的例外;它允许您省略名称空间。）
本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)
