javascript - 如何在 JSDoc 中记录事件处理程序？

Question

假设我有这样的课程：

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

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

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

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

Answer 1

关键字是@listens

使用示例：

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

推论是引发事件的@fires关键字。

Answer 2

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

因此，最好的方法是将其记录为普通函数，可能在其描述中以粗体或大写字母书写，即“事件处理程序”。

您现在可能已经这样做了，但以防万一：您可以通过简单地将文本包装到 html 标签中以粗体书写<strong></strong>。

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