如何解决jsDoc生成文档与代码自然顺序不符的情况?

发布于 2022-09-02 00:11:18 字数 544 浏览 13 评论 0

自己写的代码注释用jsDoc生成文档,发现成员变量生成出来的顺序是不一样的。
试了一下,比如:

/**
 * exports
 * @type {Object}
 */
var exports = {
    /**  param */
    param:{
        foo:'bar'
    },
    /** my */
    my:{
        foo:'baz'
    },
    /** test */
    test:{

    },
    /** init */
    init:function(){

    }
}

**最后生成的文档顺序:
Members: my param test**

clipboard.png

可以做到按照代码声明的顺序排列吗?没有找到相关的配置或案例。

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

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

发布评论

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

评论(1

孤单情人 2022-09-09 00:11:18

陈年老题,补上个答案
官方预置模板的排序我不太清楚,还没试过,不过第三方的模板主题(比如我用了docdash这个主题目),可以在cli 编译时指定 conf.json 文件,在conf.json里加上如下一串

    ...//上面的略
    "docdash": {
        "sort": false //是否排序
    }
~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文