如何在JSDoc中记录事件处理程序？ [关闭]

Question

假设我有一个这样的类：

function myClass(q) {
  this.someFunction = function(e) {
      console.log("Click event");
  };

  jQuery(q).click(this.someFunction);
}

有没有办法向JSDoc表明someFunction不仅仅是一个应该直接调用的函数，而是一个事件处理程序？

我看到了@event标签，但是如果我理解正确的话，这更多的是记录我的类中的一个函数，我认为它是一个事件（客户端代码也将注册，我的类将在需要时触发）而不是事件处理程序功能？

Answer 1

不，没有办法记录事件处理程序。

因此，最好的方法是将其记录为正常功能，可以在其描述中以粗体文本或大写字母书写“事件处理程序”。

你现在可能已经这样了，但以防万一：只需将文本包装成html标签<strong></strong>，就可以用粗体编写。

这个答案现已弃用，但它不允许我删除它。

Answer 2

关键字是@listens

用法示例：

/**
 * Outputs the event that happened
 *
 * @param {MyEvent} e - The observable event.
 * @listens MyEvent
 */
function myEventLogger(e) {
    console.log(e);
}

推论是用于提升事件的@fires关键字。