読み方 ： ジェーエスドック

JSDocとは？

関数の直前などに「/** ... */」という形式の特殊なコメントブロックを置き、その中に決められた書式で情報を書き込む。これにより、コードを読まずともその関数が何をするものかを把握しやすくなる。

「@param」や「@returns」といった「タグ」と呼ばれる記号を使って情報を構造的に記述する。@param は引数の名前と型・説明を示し、@returns は戻り値の型と意味を示す。他にも「@type」（変数の型）、「@throws」（発生しうるエラー）、「@example」（使用例）など多様なタグが用意されており、必要な情報を体系的に残せる。

JSDoc形式でコメントを書いておくと、専用ツールを使ってHTMLやMarkdown形式のAPIドキュメントを自動生成できる。代表的なツールに「JSDoc」（同名のコマンドラインツール）や「TypeDoc」などがあり、コメントの内容を解析して見やすい仕様書を出力する。大規模なライブラリやチーム開発では、こうした仕組みによって手作業で文書を整備する手間を大きく減らせる。

Visual Studio CodeなどのモダンなコードエディタはJSDocに対応しており、コメントの内容をもとにコード補完や型チェックを行う。関数にカーソルを合わせると引数の型や説明がポップアップ表示されるため、ライブラリの使い方をいちいち調べなくても済む場面が増える。動的型付け言語であるJavaScriptの弱点を、JSDocが部分的に補う形になっている。

この記事の著者 ： (株)インセプト IT用語辞典 e-Words 編集部
1997年8月より「IT用語辞典 e-Words」を執筆・編集しています。累計公開記事数は1万ページ以上、累計サイト訪問者数は1億人以上です。学術論文や官公庁の資料などへも多数の記事が引用・参照されています。