JSDoc命令行参数

原文：http://usejsdoc.org/about-commandline.html

在最基本的层面，JSDoc像这样使用：

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

其中 … 是其他文件生成文档的路径。

此外，可以提供的路径为一个 markdown 文件（以“.md”结尾）或者一个名为“README”文件，这将被添加到头版上的文档。请参见本说明书。

JSDoc支持大量的命令行选项，其中有许多长期和短期的形式。或者，所述命令行选项可以在给予JSDoc一个配置文件中指定。命令行选项：

选项 描述 -a , –access 只显示符号与给定的访问属性：private，protected，public或undefined，或者所有的对于所有的访问级别。默认情况下，所有除private符号显示。 -c , –configure JSDoc配置文件的路径。默认为在安装JSDoc目录下的conf.json或conf.json.EXAMPLE。 -d , –destination 文件夹中生成的文档的输出路径。对于用于JSDoc构建的Haruki模板，使用控制台数据转储到控制台。默认为./out。 –debug 日志信息可以帮助调试JSDoc本身的问题。在犀牛，当作为第一个选项传递给启动调试器。 -e , –encoding 读完所有的源文件时，假定为这种编码。默认为utf8。 -h, –help 显示JSDoc的命令行选项的信息，然后退出。 –match 只有运行测试其名称中包含。 –nocolor 当运行测试，不要使用颜色在控制台输出。在Windows中，这个选项是默认启用的。 -p, –private 包括符号标有@private的标记在生成的文档中。默认情况下，不包括private符号。 -P, –package 包含项目名称，版本，和其他细节在package.json文件中。默认为在源路径中找到的第一个package.json的文件。 –pedantic 对待错误视为致命错误和对待警告视为错误。默认为false。 -q , –query 一个查询字符串解析和存储在全局变量env.opts.query中。示例：foo=bar&baz=true。 -r, –recurse 扫描源文件和导览时递归到子目录。 -R, –readme 该README.md文件包括生成的文档。默认为在源路径中找到的第一README.md文件中。 -t , –template 使用模板的路径用于产生输出。默认为templates/default，JSDoc内置的默认模板。 -T, –test 运行JSDoc的测试套件，并把结果打印到控制台。 -u , –tutorials 对于导览，JSDoc要搜索的目录。如果省略，没有导览页将生成。查看导览说明，以了解更多信息。 -v, –version 显示JSDoc的版本号，然后退出。 –verbose 日志的详细信息到控制台JSDoc运行。默认为false。 -X, –explain 以JSON格式转储所有的doclet到控制台，然后退出。

例子

为在./src目录中的文件生成文档，使用配置文件/path/to/my/conf.json，并保存输出到./docs目录中：

/path/to/jsdoc src -r -c /path/to/my/conf.json -d docs

运行所有JSDoc的测试，其名称包含单词tag，并记录每个测试信息：

/path/to/jsdoc -T --match tag --verbose