我只需要在包含.js文件的整个目录上运行jsdoc,我通过发出命令jsdoc abc.js在ubuntu终端中的单个文件上执行此操作,但我需要的是立即对目录中的所有文件应用此命令,这样,该目录中包含js文件的所有文件都将由一个命令生成.感谢您提供的任何帮助.
尽管只询问如何为特定目录运行 JSDoc,但我认为该线程可以使用更多信息,以便阅读本文的人们可以了解其他可能有用的策略。
这是最简单的,也是问题的直接答案。--recurse您可以使用或选项对目录内的所有文件运行 JSDoc -r。
例子:
$ jsdoc -r ./src/
Run Code Online (Sandbox Code Playgroud)
这将为src/目录及其子目录内的所有文件运行 JSDoc。
本节和以下部分并不完全是问题所要求的,但希望对使用搜索引擎找到此线程的人有用。
您可能需要为位于不同目录中的所有文件运行 JSDoc。为此,您可以仅在--recurse选项中使用多个参数。
例子:
$ jsdoc -r ./client/ ./server/
Run Code Online (Sandbox Code Playgroud)
这将为client/和server/及其子目录中的所有文件运行 JSDoc。
这稍微复杂一些,需要使用 JSDoc 的配置文件。创建配置文件后,您可以使用--configure( 或-c) 选项运行 JSDoc 以选择要使用的配置文件。
示例:创建一个文件conf.json,如下所示:
$ jsdoc -r ./src/
Run Code Online (Sandbox Code Playgroud)
然后像这样运行 JSDoc:
jsdoc -c ./conf.json -r
Run Code Online (Sandbox Code Playgroud)
这样,JSDoc 将对当前目录及其子目录中的所有文件运行,但位于其中node_modules/及其子目录中的文件除外。
jsdoc有关该命令的可用选项的更多信息,请参阅此处
有关 JSDoc 配置文件的更多信息,请参阅此处
| 归档时间: |
|
| 查看次数: |
5027 次 |
| 最近记录: |