JSDoc的命令行参数

在最基本的层面上, JSDoc就像这样使用:

/path/to/jsdoc yourSourceCodeFile.js anotherSourceCodeFile.js ...

其中 ... 是生成其他文件的路径.

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 引入README文件.

JSDoc supports a number of command-line options, many of which have both long and short forms. Alternatively, the command-line options may be 使用配置文件配置JSDoc given to JSDoc. The command-line options are:

选项	描述
-a <value>, --access <value>	只显示具有给定 access 属性的符号: private, protected, public``或``undefined, 或者所有访问级别的``all``. 默认情况下, 显示除 `private `符号以外的所有符号.
-c <value>, --configure <value>	The path to a JSDoc 使用配置文件配置JSDoc. Defaults to conf.json or conf.json.EXAMPLE in the directory where JSDoc is installed.
-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	Include symbols marked with the @private in the generated documentation. By default, private symbols are not included.
-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格式转储到控制台, 然后退出.

示例

使用配置文件 /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