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

发布于 2024-08-22 09:42:42 字数 347 浏览 4 评论 0原文

假设我有一个这样的类：

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

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

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

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

原文

Suppose I have a class like this:

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

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

Is there a way to indicate to JSDoc that someFunction is not just a function that should be invoked directly but rather is an event handler ?

I see the @event tag but if I understand correctly this is more to document a function in my class that I consider to be an event (something the client code would register too and that my class will fire when needed) and not an event handler function ?

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

惯饮孤独 2024-08-29 09:42:42

关键字是 @listens

用法示例：

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

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

The keyword is @listens

Usage example:

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

The corollary is the @fires keyword for raising the event.

回复收藏 0 原文