JavaScriptの関数コメントに標準規格はある？JSDocスタイルの書き方を解説

JavaScriptの関数コメントには標準仕様があるのか

結論から言うと、JavaScriptの言語仕様（ECMAScript）自体には、関数のドキュメント用コメントに関する公式の標準は定義されていません。しかし、業界ではJSDocと呼ばれる記述スタイルが事実上の標準（デファクトスタンダード）として広く普及しています。

JSDoc形式でコメントを記述しておくと、Visual Studio Codeをはじめとする多くのエディタやIDEが、入力補完や引数の型ヒント、関数の説明ポップアップなどを自動的に表示してくれるため、コードの可読性と保守性が大きく向上します。

JSDocスタイルの記述例

以下は、2つの数値を加算する関数に対して、JSDoc形式のドキュメンテーションコメントを記述した例です。

/**
 * 2つの数値を加算する
 * @param {Number} a - 1つ目の数値
 * @param {Number} b - 2つ目の数値
 * @return {Number} 合計値
 */

function sum(a, b) {
    return a + b;
}

主なJSDocタグの意味

• @param {型名} 変数名 … 関数の引数の名前とデータ型を記述します。
• @return {型名} … 戻り値の型と内容を記述します。

このようにJSDoc形式でコメントを統一しておくことで、チーム開発における認識のズレを防げるだけでなく、TypeScriptの型チェックや各種ドキュメント生成ツールとの連携も可能になります。JavaScriptで関数を書く際は、JSDocスタイルのコメントを付ける習慣をつけておくことをおすすめします。