包含包文件

包文件包含对项目文档有用的信息，例如项目的名称和版本号。JSDoc 在生成文档时可以自动使用项目 package.json 文件中的信息。例如，默认模板在文档中显示项目的名称和版本号。

有两种方法可以将 package.json 文件纳入文档

在 JavaScript 文件的源路径中，包含 package.json 文件的路径。JSDoc 将使用在源路径中找到的第一个 package.json 文件。
使用 -P/--package 命令行选项运行 JSDoc，指定 package.json 文件的路径。此选项在 JSDoc 3.3.0 及更高版本中可用。

-P/--package 命令行选项优先于源路径。如果你使用 -P/--package 命令行选项，JSDoc 将忽略源路径中的任何 package.json 文件。

package.json 文件必须使用 npm 的包格式。

示例

在源路径中包含包文件

jsdoc path/to/js path/to/package/package.json

使用 -P/--package 选项

jsdoc --package path/to/package/package-docs.json path/to/js