JSDoc 的命令行参数
在最基本级别，JSDoc 的用法如下
/path/to/jsdoc yourSourceCodeFile.js anotherSourceCodeFile.js ...
其中 ... 是要生成文档的其他文件的路径。
此外，可以提供 Markdown 文件（以 “.md” 结尾）或名为 “README” 的文件的路径，这将添加到首页的文档中。请参阅 这些说明。
JSDoc 支持许多命令行选项，其中许多选项既有长形式又有短形式。或者，可以在给定 JSDoc 的 配置文件 中 指定命令行选项。命令行选项如下
| 选项 | 说明 |
|---|---|
-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 |
以 JSON 格式将所有文档转储到控制台，然后退出。 |
示例
使用配置文件 /path/to/my/conf.json 为 ./src 目录中的文件生成文档，并将输出保存在 ./docs 目录中
/path/to/jsdoc src -r -c /path/to/my/conf.json -d docs
运行所有名称包含单词tag的 JSDoc 测试，并记录每个测试的信息
/path/to/jsdoc -T --match tag --verbose