javascript - JSDoc 保留输出中注释的顺序

Question

我有一个 JavaScript 对象，它引入了一些公共(public)方法，我想使用 JSDoc 来记录它们。

在源文件中，我以合理的顺序对这些函数进行了分组和排序，但是在生成 JSDoc 之后，我按字母顺序接收了所有这些函数，这没有多大意义。

有什么办法可以保持输出的顺序吗？我找不到任何答案，但我也找不到这是不可能的。

Answer 1

简短的回答:

在您的 conf.json 文件中，添加 "sort": false 的 opts 元素，其中 sort 标记 JSDoc 是否应使用字母排序。

假设您正在使用 conf.json 文件来指定您的 JSDOC 配置选项:

jsdoc -c path/to/conf.json

例如:

{
    "tags": {
        "allowUnknownTags": false
    },
    "source": {
        "includePattern": ".+\\.js(doc)?$",
        "excludePattern": "(^|\\/|\\\\)_"
    },
    "plugins": [],
    "templates": {
        "cleverLinks": true,
        "monospaceLinks": false,
    },
    "opts": {
        "encoding": "utf8",
        "lenient": false,
        "sort": false
    }
}

我也遇到了Docstrap , JSDoc3 的 Bootstrap 模板。

然后您可以使用模板部分中的“排序”选项。这种情况下的 conf.json 文件示例可能显示为:

{
    "tags": {
        "allowUnknownTags": true,
        "dictionaries": ["jsdoc","closure"]
    },
    "source": {
        "includePattern": ".+\\.js(doc|x)?$",
        "excludePattern": "(^|\\/|\\\\)_"
    },
    "plugins": [],
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": false
        "sort": false
    }
}

Docstrap 网站给出的描述是:

sort Defaults to true. Specifies whether jsdoc should sort data or use file order. Can also be a string and if so it is passed to jsdoc directly. The default string is "longname, version, since".