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

mc_zone
  • 282

自己写的代码注释用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

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

回复
阅读 2.9k
1 个回答

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

    ...//上面的略
    "docdash": {
        "sort": false //是否排序
    }
撰写回答
你尚未登录,登录后可以
  • 和开发者交流问题的细节
  • 关注并接收问题和回答的更新提醒
  • 参与内容的编辑和改进,让解决方法与时俱进
宣传栏