Question

我有一个JavaScript对象，它介绍了一些公共方法，我想使用JSDoc来记录它们。

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

有没有办法保持输出中的顺序？我找不到任何答案，但我也发现这是不可能的。

Answer 1

答案简短：

在你的conf.json文件中，添加一个＆＃34; sort＆＃34;：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模板。

然后，您可以使用＆＃39;排序＆＃39;模板部分中的选项。此案例的conf.json文件示例可能显示为：

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

Docstrap网站提供的描述是：

排序默认为true。指定jsdoc是否应对数据排序或使用文件顺序。也可以是字符串，如果是，则直接传递给jsdoc。默认字符串是＆＃34; longname，version，因为＆＃34;。

JSDoc保留输出中的注释顺序

1 个答案: