【タイプドック】
TypeDoc とは？
最終更新:
💡 コードの型とコメントから、APIの説明を生成する
TypeScriptのソースコードの型情報や説明コメントを基に、APIドキュメントを生成するツール。公開する入口となるファイルなどを指定し、HTMLやJSONモデルとして出力できる。
📌 このページのポイント
- TypeScriptの公開する関数・クラス・型などを文書化する
- 既定では/**から始まる説明コメントを読み取る
- 本体はHTMLとJSONを出力し、Markdown出力にはプラグインを使う
- 入口・出力先・テーマや複数パッケージの扱いを設定する
ひよこ TypeDocって何をしてくれるの？
ペンギン先生 ひよこ コメントを書かなくても全部説明してくれる？
ペンギン先生 型などから分かる情報は取り出せるけれど、処理の目的や使い方が自動で補われるわけではないよ。既定では/**から始まる説明コメントを読むので、型だけでは伝わらないことを書いておこう。
ひよこ どうやって使うの？
ペンギン先生 例えばnpm install --save-dev typedocで導入し、npx typedoc src/index.tsのように入口を指定するよ。入口のファイルがexportするものをたどって文書化する。実行にはプロジェクトのTypeScript設定なども関係するんだ。
ひよこ 何の形式で出力できるの？
ペンギン先生 ひよこ 複数パッケージのプロジェクトでも使える？
ペンギン先生 本体のentryPointStrategyをpackagesにする方法があるよ。各パッケージを変換し、まとめて出力する。パッケージごとの設定場所にも注意しよう。生成した文書は、説明の不足や公開したい範囲を確認してから使うんだ。
まとめ：ざっくりこれだけ覚えればOK！
📖 おまけ：英語の意味
「TypeDoc」 ＝ TypeScriptのドキュメント生成ツールの名前
💬 TypeScriptの型情報を活かして、関数などの使い方を読むための文書を作るツールだよ。型だけで分からない目的や注意点は、説明コメントで補うんだ。