jsDoc 如何注释工厂模式

发布于 2022-09-04 04:15:59 字数 614 浏览 27 评论 0

/**
 * @module gateHandler
 * @extends Handler
 * /

/**
 * 获取gateHandler
 * @param {Object} app
 * @return {Object} - 返回Handler类的实例 
 */
module.exports = function(app) {
    return new Handler(app);
};

/**
 * 
 * @type Handler
 * @param {Object} app
 */
var Handler = function(app) {
    this.app = app;
};
var handler = Handler.prototype;


/**
 * @name queryEntry
 * @member Handler
 * @param {string} msg
 * @param {Object} session
 * @this Handler
 * @callback {next} next 
 */
handler.queryEntry = function(msg, session, next) {}

知道上面注释的不对无法生成正确的文档,不知道工厂模式的注释应该怎么用jsDoc来写,求教

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

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文