引入包文件¶
包文件包含对项目文档有用的信息, 例如项目的名称和版本号. 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’s package format.