Question

如何使用jsdoc表示@param是MouseEvent？ HTMLElement DIV？

/**
 * @param {MouseEvent} e
 */
 window.clickToButton = function(e) 
 {  
     console.dir(e);
 }

/**
 * @param {HTMLElement} d
 */
 window.clickToDiv = function(d)
 {
     console.dir(d);
 }

Answer 1

实际上，您最好使用@event标记来记录正确的事件类型，因为它与其他与事件相关的标记（如@fires和@listens）集成在一起@typedef没有的方式。根据您想要的详细程度，您甚至可以命名它们。以下是基础知识 - 我将使用jQuery编写此代码，只是为了使代码更简单。

通常，您希望将事件类型附加到某个命名空间，类，名称等。因为您尝试记录本机事件类型，所以使用＆＃34; document＆＃34;可能有意义（或窗口，或全局，或本机，或任何你喜欢的）

/**
 * @namespace document
 */

如果您愿意，您甚至可以获得更多细化并执行类似

的操作

/**
 * @namespace root.events.mouse
 */

但是为了讨论，我们只会坚持使用document。

鼠标事件有很多属性，但您实际上只需要记录您关心的事件。这里是一个名为mouseEventParams的通用typedef，它定义了在处理jQuery事件时最常用的一些属性：

/**
 * @typedef {{
 *  target: element,
 *  which: number,
 *  pageX: number,
 *  pageY: number,
 *  clientX: number
 *  clientY: number
 * }} mouseEventParams
 */

现在我们已经记录了鼠标事件中应该包含哪种数据，因此我们现在可以定义不同的事件类型，并确保记录其属性而不会过多地重复。通过首先声明命名空间，然后是＆＃39;＃＆＃39;然后是事件名称，表明事件是相应命名空间的一部分。

/**
 * Mousedown Event
 * @event document#mousedown
 * @type {mouseEventParams}
 */

/**
 * Mouseup Event
 * @event document#mouseup
 * @type {mouseEventParams}
 */

定义这些事件及其属性的另一种方法，假设您不关心每个事件的相同属性，将执行以下操作：

/**
 * Mousedown Event
 * @event document#mousedown
 * @type {object}
 * @property {element} target
 * @property {number} which
 */

/**
 * Mouseup Event
 * @event document#mouseup
 * @type {object}
 * @property {number} pageX
 * @property {number} pageY
 * @property {number} clientX
 * @property {number} clientY
 */

如果要引用另一个doclet中的事件，则需要注意JSDoc会自动将字符串event:添加到每个事件名称上，作为一种仅用于事件的命名空间。这意味着您需要包含＆＃34;命名空间＆＃34;在引用来自其他doclet的事件时，@fires和@listens的情况除外，因为暗示了event:命名空间。

// Notice the inclusion of 'event:' between '#' and 'mousedown' on `@param`
// But you don't need it on 'listens'
/**
 * Handles mousedown events
 * @param  {document#event:mousedown} event
 * @listens document#mousedown
 */
var someMouseHandler = function (event) {
    console.log("mousedown event: ", e);
}

// Again, you don't need to include 'event:' for the `@fires` tag
/**
 * Triggers a mouseUp event
 * @param {element} element
 * @fires document#mouseup
 */
var triggerMouseUp = function (element) {
    $(element).trigger('mouseup');
}

Answer 2

/**
 * @typedef {object} MouseEvent
 * @typedef {object} HTMLElement
 */

/**
 * @param {MouseEvent} e
 */
window.clickToButton = function(e) {  
    console.dir(e);
}

/**
 * @param {HTMLElement} d
 */
window.clickToDiv = function(d) {
    console.dir(d);
}

http://usejsdoc.org/tags-type.html

http://usejsdoc.org/tags-typedef.html

如何jsdoc表明@param是MouseEvent？

2 个答案: