@use JSDoc

パッケージ ファイルのインクルード

パッケージ ファイルには、プロジェクトのドキュメントで役立つ情報、たとえばプロジェクトの名前とバージョン番号が含まれています。JSDoc は、ドキュメントを生成するときに、プロジェクトの package.json ファイルから自動的に情報を使用できます。たとえば、デフォルトのテンプレートは、ドキュメントにプロジェクトの名前とバージョン番号を表示します。

package.json ファイルをドキュメントに取り込む方法は 2 つあります。

  1. JavaScript ファイルのソース パスに、package.json ファイルへのパスを含めます。JSDoc は、ソース パスで最初に検出した package.json ファイルを使用します。
  2. package.json ファイルのパスを指定して、-P/--package コマンドラインオプションを使用して JSDoc を実行します。このオプションは 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