JSDoc 的命令行参数
在最基本的层面上，JSDoc 的使用方式如下：
¥At its most basic level, JSDoc is used like so:
/path/to/jsdoc yourSourceCodeFile.js anotherSourceCodeFile.js ...
其中 ... 是要为其生成文档的其他文件的路径。
¥where ... are paths to other files to generate documentation for.
此外，还可以提供 Markdown 文件（以 ".md" 结尾）或名为 "README" 的文件的路径，这将添加到首页的文档中。参见 这些说明。
¥Additionally, one may provide the path to a Markdown file (ending in ".md") or a file named "README", and this will be added to the documentation on the front page. See these instructions.
JSDoc 支持许多命令行选项，其中许多选项都有长形式和短形式。或者，命令行选项可以是给 JSDoc 的 在配置文件中指定。命令行选项是：
¥JSDoc supports a number of command-line options, many of which have both long and short forms. Alternatively, the command-line options may be specified in a configuration file given to JSDoc. The command-line options are:
| 选项 | 描述 |
|---|---|
-a <value>、--access <value> |
仅显示具有给定 access 属性的符号：private、protected、public、undefined 或 all 适用于所有访问级别。默认情况下，显示除 private 符号之外的所有符号。 |
-c <value>、--configure <value> |
JSDoc 配置文件 的路径。默认为 JSDoc 安装目录中的 conf.json 或 conf.json.EXAMPLE。 |
-d <value>、--destination <value> |
生成的文档的输出文件夹的路径。对于 JSDoc 内置的 Haruki 模板，使用 console 将数据转储到控制台。默认为 ./out。 |
--debug |
可以帮助调试 JSDoc 本身问题的日志信息。 |
-e <value>、--encoding <value> |
读取所有源文件时假定此编码。默认为 utf8。 |
-h、--help |
显示有关 JSDoc 命令行选项的信息，然后退出。 |
--match <value> |
仅运行名称包含 value 的测试。 |
--nocolor |
运行测试时，不要在控制台输出中使用颜色。在 Windows 上，此选项默认启用。 |
-p、--private |
在生成的文档中包含标有 @private 标签 的符号。默认情况下，不包括私有符号。 |
-P、--package |
package.json 文件包含项目名称、版本和其他详细信息。默认为源路径中找到的第一个 package.json 文件。 |
--pedantic |
将错误视为致命错误，并将警告视为错误。默认为 false。 |
-q <value>、--query <value> |
要解析并存储在全局变量 env.opts.query 中的查询字符串。示例：foo=bar&baz=true。 |
-r、--recurse |
扫描源文件和教程时递归到子目录。 |
-R、--readme |
要包含在生成的文档中的 README.md 文件。默认为源路径中找到的第一个 README.md 文件。 |
-t <value>、--template <value> |
用于生成输出的模板的路径。默认为 templates/default，JSDoc 的内置默认模板。 |
-T、--test |
运行 JSDoc 的测试套件，并将结果打印到控制台。 |
-u <value>、--tutorials <value> |
JSDoc 应在其中搜索教程的目录。如果省略，将不会生成任何教程页面。请参阅 教程说明 了解更多信息。 |
-v、--version |
显示 JSDoc 的版本号，然后退出。 |
--verbose |
当 JSDoc 运行时，将详细信息记录到控制台。默认为 false。 |
-X、--explain |
将所有 doclet 以 JSON 格式转储到控制台，然后退出。 |
示例
¥Examples
使用配置文件 /path/to/my/conf.json 为 ./src 目录中的文件生成文档，并将输出保存在 ./docs 目录中：
¥Generate documentation for files in the ./src directory, using the configuration file
/path/to/my/conf.json, and save the output in the ./docs directory:
/path/to/jsdoc src -r -c /path/to/my/conf.json -d docs
运行名称中包含单词 tag 的所有 JSDoc 测试，并记录有关每个测试的信息：
¥Run all JSDoc tests whose names include the word tag, and log information about each test:
/path/to/jsdoc -T --match tag --verbose