jsdoc3 中事件标签的工作示例

Question

谁能给我一个如何正确使用@event标签的例子。

我在这里查看了 jsdoc3 文档： http://usejsdoc.org/tags-event.html 但我无法让它工作。

我正在使用 nodejs，并且我在 MyClass/index.js 中有一个模块，它以 MyClass 的名称导出构造函数：

module.exports = MyClass;
myClass = function () { ... };

我已经尝试添加

/**
 * Snowball event.
 * @event MyClass#snowball
 */

在编译的文档中，snowball 出现在全局事件列表中，但是当我点击它时，它告诉我

The requested URL /{path-to-my-docs}/MyClass.html was not found on this server.

提前致谢。

Answer 1

这很好用：

/**
 * @class
 */
function Blah() {
}

/**
 * @event Blah#something
 * @type {Object}
 * @property {integer} some_field Represents something or other.
 */