使用JSDoc记录事件侦听器

Documenting event listeners with JSDoc

本文关键字：侦听器 事件 记录 JSDoc 使用      更新时间：2024-05-18

我有这个类构造函数：

/**
 * @class Game renderer.
 * @exports Renderer
 * @constructor
 * @param {number=} width canvas width. Defaults to 1024.
 * @param {number=} height canvas height. Defaults to 720.
 */
var Renderer = function(width, height) {
    'use strict';
    // more code ...
    document.body.appendChild(this.canvas);
};

我应该如何记录最后一行？如果我有事件监听器？例如：

canvas.onmousemove = function(event) {
  // do something
};

您可以使用JSDOC3的@listeners标签，：）

相关文章：