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.
 */