jsdoc3中事件标记的工作示例

有人可以给我一个关于如何正确使用@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. */