JSDocコメントの有効活用。JavaScriptやTypeScriptのドキュメントを生成する方法 記事「JavaScriptでJSDocコメントを書くメリットとは」でJSDocコメントの有用性について紹介しました。その中で「APIドキュメントの書き出し」をメリットの1つとして取り上げています。 APIドキュメントの利用用途として以下が挙げられます。 JSライブラリの使い方を参照しやすくするため、APIドキュメントとして公開したい 他の開発チームへモジュールの使い方を説明するために、APIドキュメントを用意したい プロジェクトのJavaScriptコードを使って、形式的な納品物の成果物を作りたい 本記事ではAPIドキュメントの作成方法を解説します。 サンプルの紹介 サンプルをGitHubに用意していますので完成系をご覧ください。サイドバーを使うことで関数や定数などのドキュメントをたどるこ