本文へスキップ
変換ツール

JSONからJSDocコメントへの変換器

JSON サンプルのプロパティから JSDoc の @typedef と @property コメントを生成します。JavaScript のデータ構造を説明し、エディターの型補完に使うコメントの下書きをブラウザ内で作れます。

JavaScript で扱う API レスポンスのプロパティをコメントにまとめる。

JSON

JSDoc

こんなときに使えます

  • JavaScript で扱う API レスポンスのプロパティをコメントにまとめる。
  • TypeScript へ移行せず、JSON データの型をコードの近くに記録する。

使い方

  1. 入力欄に JSON オブジェクトを貼り付けるか、JSON ファイルを読み込みます。
  2. 右側の @property でキーと型を確認します。以下の例では id と name が string、active が boolean になります。
  3. 生成されたコメントをコピーし、型名 json を用途に合わせて変更します。説明文や省略可能な値は実際の仕様を確認して補ってください。

入力例

{"id":"001","name":"東京","active":true}

出力例

/** @typedef {object} json
 * @property {string} id
 * @property {string} name
 * @property {boolean} active
 */

仕様と注意点

生成されるのはコメントです。実行時の入力検証や JavaScript の関数本体は作りません。

サンプルに含まれないフィールドや、文字列の形式・数値の範囲は推定できません。ネストや配列を含む場合も、生成結果を実データと照合してください。

001 のような識別子は引用符で囲んで入力します。数値に変換された後の先頭ゼロは復元できません。

変換はブラウザ内で行います。TypeScript の型定義が必要な場合は JSON → TypeScript、実行時検証用コードが必要なら JSON → Zod を使えます。

入力内容は同じタブ内に一時保存され、再読み込みや同じ入力形式のツールで再表示される場合があります。共用端末では、使い終わったら入力欄をクリアしてください。