@JSDocを使用する

JSDocのコマンドライン引数

非常に基本的なレベルで、JSDocはこのように使用されます

/パス/jsdoc yourSourceCodeFile.js anotherSourceCodeFile.js ...

ここで「...」はドキュメントを生成する他のファイルへのパスです。

さらに、Markdownファイル(「.md」で終わる)や「README」という名前のファイルへのパスを指定すると、それらはフロントページのドキュメントに追加されます。こちらの手順を参照してください。

JSDocは多くのコマンドラインオプションをサポートしており、それらの多くには長い形式と短い形式の両方があります。その一方で、コマンドラインオプションはJSDocに与えられた設定ファイルで指定することもできます。コマンドラインオプションは次のとおりです。

オプション 説明
-a <値>、--access <値> 指定されたaccessプロパティを持つシンボルのみを表示します：private、protected、public、undefined、またはすべてのアクセスレベルの場合はallです。デフォルトでは、privateシンボルを除くすべてが表示されます。
-c <値>、--configure <値> JSDocの設定ファイルへのパスです。デフォルトは、JSDocがインストールされているディレクトリ内のconf.jsonまたはconf.json.EXAMPLEです。
-d <値>、--destination <値> 生成されたドキュメントの出力フォルダーへのパスです。JSDocの組み込みHarukiテンプレートの場合、consoleを使用してデータをコンソールにダンプします。デフォルトは./outです。
--debug JSDoc自体における問題のデバッグに役立つ情報をログに出力します。
-e <値>、--encoding <値> すべてのソースファイルを読み込むときに、このエンコーディングを使用します。デフォルトはutf8です。
-h、--help JSDocのコマンドラインオプションに関する情報を表示してから終了します。
--match <値> 値を含む名前のテストのみを実行します。
--nocolor テストを実行する場合、コンソール出力に色を使用しません。Windowsでは、このオプションがデフォルトで有効になっています。
-p、--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 形式でコンソールにダンプして終了します。

例

./src ディレクトリのファイルのドキュメントを、構成ファイル /path/to/my/conf.json を使用して生成し、出力を ./docs ディレクトリに保存します

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

名前に tag という単語が含まれるすべての JSDoc テストを実行し、各テストに関する情報をログに記録します

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