JSDoc 正确记录事件监听器答案

【问题标题】：JSDoc documenting event listeners properlyJSDoc 正确记录事件监听器
【发布时间】：2020-06-26 08:20:14
【问题描述】：

我一直在学习如何在我的项目中使用 JSDoc，除了一两件事之外，我大多了解如何使用它。其中之一是记录事件侦听器。

我看过@listens 上的文档，但他们给出的解释/示例对我来说没有意义。这是该页面的链接：https://jsdoc.app/tags-listens.html

我想知道是否有人有更好的方法向我解释它，或者向我展示你如何记录基本事件侦听器的示例。（我在下面提供一个）

document.getElementById('some_element').addEventListener('mousedown', function () {
  // Some code
});

谢谢

【问题讨论】：

记录事件监听器是什么意思？您似乎正在尝试询问如何编写 Document 侦听器。此外，指向对您没有意义的特定文档的链接可能会有所帮助。最后，更多的上下文代码将对其他人有所帮助，因为他们可以更容易地找出问题所在。您是否尝试过该示例行？如果是这样，您在控制台中遇到了什么样的错误？
@rocha 感谢您的评论。生病编辑我的问题更具体。只是为了回答你的几个问题x我的问题不在于代码，我使用的是一个名为 JSDoc 的文档工具，我想知道如何正确记录监听器。我会在我的问题中提供指向该页面的链接
知道了，谢谢你的解释。即使 JSDoc 中的 @events 和 @listens 标签文档根本没有帮助，这行特定的代码似乎也很容易记录，这很讽刺。首先，可能是对作为类型的 HTML 元素的引用：@type {HTMLElement}。然后可能是这样的：@event document#mousedown 或 @listens document#mousedown，您首先声明命名空间，然后是 #，最后是事件名称。

标签： javascript jsdoc

【解决方案1】：

扩展我上面的评论，我认为以下是记录该代码行的可接受方式，其中document 是命名空间，后跟事件名称mousedown：

/**
 * Listen to mousedown event
 *
 * @type {HTMLElement} - the target of the event
 * @listens document#mousedown - the namespace and name of the event
 */

document.getElementById('some_element').addEventListener('mousedown', function () {
  // Some code
});

【讨论】：