如何记录返回的事件发射器答案

【问题标题】：How to document an event emitter returned如何记录返回的事件发射器
【发布时间】：2016-04-11 16:20:38
【问题描述】：

如何用JSDoc记录stream在MyFunc()返回的事件？

/**
 * [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;
}

【问题讨论】：

标签： javascript jsdoc eventemitter

【解决方案1】：

您可以通过将您的事件（event1、event2、...）记录为 @event MyFunc#event1 和 MyFunc，或使用 @fires MyFunc#event1 进行发射的任何人来记录这些行为。

您还可以使用 @listens MyFunc#event:event1 记录监听这些事件的函数。

以下是上述标签的官方 JSDoc 页面：

请注意标签事件页面中提到的“事件”的一些细微差别，在此重复：

JSDoc 自动将命名空间event: 添加到每个事件的名称。通常，当您链接到另一个 doclet 中的事件时，您必须包含此名称空间。（@fires 标记是一个值得注意的例外；它允许您省略命名空间。）

【讨论】：