如何在ubuntu中的整个目录上运行jsdoc

Question

我只需在包含.js文件的ai整个目录上运行jsdoc，我将通过发出命令jsdoc abc.js对ubuntu终端中的单个文件执行jsdoc命令，但我需要的是一次对目录中的所有文件应用此命令，以便该目录中包含js文件的所有文件都由单个命令生成。谢谢你的帮助。

Answer 1

您可以通过传递-r参数来进行递归：

$ jsdoc -r .

Answer 2

尽管只询问如何为特定目录运行JSDoc，但我认为这个线程可以使用更多的信息，这样人们就可以知道其他可能有用的策略。

运行特定目录的JSDoc

这是最简单的问题，也是对问题的直接回答。可以使用JSDoc或-r选项对目录中的所有文件运行--recurse。

示例：

$ jsdoc -r ./src/

这将对JSDoc目录及其子目录中的所有文件运行src/。

为多个目录运行JSDoc

这部分和下面的部分并不是真正的问题，但希望对使用搜索引擎找到这个线程的人有帮助。

您可能需要对位于不同目录中的所有文件运行JSDoc。为此，您可以在--recurse选项中使用多个参数。

示例：

$ jsdoc -r ./client/ ./server/

这将对JSDoc和client/和server/及其子目录中的所有文件运行。

某些目录不运行JSDoc

这稍微复杂一些，需要使用JSDoc的配置文件。创建配置文件后，可以使用JSDoc (或-c)选项运行配置文件，以选择要使用的配置文件。

示例:创建一个文件conf.json，如下所示：

{
    "source": {
        "include": [ "." ],
        "exclude": [ "node_modules/" ]
    }
}

然后像这样运行JSDoc：

jsdoc -c ./conf.json -r

对于当前目录及其子目录中的所有文件，除位于JSDoc及其子目录中的文件外，还将运行node_modules/。

资料来源

有关jsdoc命令可用选项的更多信息，请参见这里

有关JSDoc配置文件的更多信息，请参见这里