如何在Ubuntu上对整个目录运行jsdoc

Question

我只需要在包含.js文件的整个目录上运行jsdoc。我在Ubuntu终端上通过发出命令jsdoc abc.js 在单个文件上执行此操作，但我需要一次将此命令应用于目录中的所有文件，以便该目录中包含js文件的所有文件都会生成单个命令。感谢您提供的任何帮助。

- SQA

Answer 1

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

$ jsdoc -r .

- Dmitry Demidovsky

---

在扫描源文件和教程时，递归进入子目录。 - Doug Wilhelm

Answer 2

运行特定目录下的JSDoc

虽然只有被问及如何在特定目录下运行JSDoc，但我认为这个主题可以提供更多信息，以便阅读此内容的人了解其他可能有用的策略。

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

示例：

$ jsdoc -r ./src/

运行多个文件夹的JSDoc

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

这一部分内容和下面的内容并不完全符合问题要求，但希望对使用搜索引擎找到此线程的人有所帮助。

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

例如：

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

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

不运行某些目录的JSDoc

这需要使用JSDoc的配置文件，并且稍微复杂一些。创建配置文件后，您可以使用--configure（或-c）选项来运行JSDoc并选择要使用的配置文件。

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

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

那么就像这样运行 JSDoc：

jsdoc -c ./conf.json -r

这样一来，JSDoc将会运行您当前目录及其子目录中除了位于node_modules/及其子目录中的文件之外的所有文件。

来源

如需了解jsdoc命令的可用选项的更多信息，请参见此处

如需了解JSDoc配置文件的更多信息，请参见此处

- Float07