包含套件檔案

套件檔案包含對專案文件有用的資訊，例如專案名稱和版本號碼。JSDoc 在產生文件時，可以自動使用專案的 package.json 檔案中的資訊。例如，預設範本會在文件中顯示專案名稱和版本號碼。

有兩種方法可以將 package.json 檔案納入文件中

1. 在 JavaScript 檔案的來源路徑中，包含 package.json 檔案的路徑。JSDoc 會使用在來源路徑中找到的第一個 package.json 檔案。
2. 使用 -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

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