JSON にもコメントを書きたい - Qiita

そう、JSON にはコメントを記載するための構文がないのです。近年では設定ファイルなどで利用されることも多い JSON ですが、コメントによる説明が不要なキーを名付けることは現実的ではありません。どうしよう、困ったな。 TL;DR コメントをつけるだけなら JSONC を使いましょう。 （2020-02-17追記） 各フォーマットの比較などに使えるデモページを公開してみました。 （2020-03-15追記） 続編を書きました。 どうしても JSON にコメントを書きたい 同じようなことに悩む先人は多いため、インターネット上には様々なアイデアが提案されています。 たとえば JSON Schema Core Draft 2019-091 では以下のような記述があります： 8.3. Comments With "$comment" This keyword reserves a location

[regularexception]

データにも、「なぜこの値が入っているか」というコメントをいれたいことはあるよ

[midnight-railgun]

JSON5ってジャクソン5みある

[EngineerYtr]

この「JSONにコメント書きたい」って感想自体に違和感。データにコメント付けてどうするのよ。本来なら設計書、次点でソース内じゃないの？

[Kil]

こっちはJSONCに従って書いてるんだ！　って主張したところで、他所のWebAPIとかメジャーなライブラリがそれを解釈してくれなかったら無意味だからなぁ。

[mochieer]

APIで返そうとかいう話ではなく、設定ファイルとか、どこぞの誰かが決めた「このキーにこの値をいれるとこうなる」からそうしている場合はコメントしたいとき多い。（が、その場合はJSONCを使う自由はこちらにない）

[chinpokomon_master]

JSONがデータにしか使われてないと思ってるコメント、どんな環境で仕事してるんだろうか？

[inductor]

jsonnetくんが無くて泣いた

[fai_fx]

結局、そのJSONを何に読ませたいか？次第のような

[gachapining]

拡張子は大体 .json になってるから、json5 として parse されてても editor や linter は予期に計らってくれないだよなぁ。拡張子をちゃんと使い分ける文化になってほしい

[Hamukoro]

XML…

[minamishinji]

JSONでコメントが使えないのはさっきまで知りませんでした…

[n314]

ブコメ見てると、データフォーマットとして作られたJSONを設定ファイルとして利用するのが間違っている、みたいな流れか。まあ正しいけど既に広く使われているのでね…。

[kkobayashi]

atomはcsonだったような・・・。設定ファイルとかで使われる想定じゃなかったんだろうなあ。

[green0]

https://twitter.com/t_yano/status/1117311146132815878

[Ioannes]

気持ちはわかるが、コード側の型やらコメントで表現しろとしか

[securecat]

最初のほうのStringでコメントするってのが、なんだかんだ固そうな？

[umai_bow]

YAML、ハイフン忘れてオブジェクトが合体するみたいなミスよくやらかす（自分だけでなくチーム内でよく起こる）ので好きじゃない。JSONならエラー吐いてくれるし、なんでYAMLが重宝されるのかわかっていない

[zkq]

「JSONは機械が扱う」ってんならテキストである必要はない。コメントはしたい。

[otchy210]

例としても挙がってたけど、おれおれで {"__comment": "hogehoge"} は実際にやったことあるなぁ。

[ghostbass]

コードとデータのくべつなんてないやん。だからコメントは必要。

[deokisikun]

いろんなのあるんだね。けどやめとくが吉かな

[monorod]

package.jsonにコメントを書きたくなる気持ちはわかる。APIからの返り値だけがjsonじゃないんだよな

[ene0kcal]

「データにコメントつけるな」という意見もわかるが、度々JSONにコメント書きたいという意見を聞くので難しいところ。そしてJSON5ではコメントできるようになったので方向としてはそれで良いのだろう。

[yhara]

json5いいよね

[gomakyu]

ISC kea DHCPサーバで初めてJSON触ってる。わーたーしーレイヤー3ー(でご飯食べてます)。

[solidstatesociety]

ケツカンマ

[asiamoth]

“実は JSON は YAML のサブセット”とは知らなかった。人間が書くならYAMLで、それをJSONに変換してコンピュータに読ませれば良いね。

[naari_3]

yamlでjsonみたいな記述できること知らなかった

[t_motooka]

ここまで様々な代替手段を挙げられる文書においても無視されるXMLさん…（私はXMLさんのことを信じてる）

[snipesnaps]

CoffeeScriptが無駄に不安がられてて笑った

[mohno]

「JSON にはコメントを記載するための構文がない」←そうなんだ。直接手書きすることはなかったけど、そういう使い方するならコメント文は欲しかったね。

[whirl]

ある種のゲームMODの設定ファイルを書き換えるときにJSONではコメントが許されてねえんだよとエディタに怒られるのほんとどうにかしてほしい

[xenon_abe]

HOCON いいですよ。

[diveintounlimit]

yaml/cson/hjson/json5/jsonc

[hazardprofile]

怖い。怖くない？怖い

[iww]

『実は JSON は YAML のサブセットです。』

[daichirata]

まさにこういう config data 等を対象としている Jsonnet さんのことも忘れないであげて... / 特に js なんかは config がまんま json だから、そういう認識があるかないかで意見が別れている気がする

[shikiarai]

分かる。このファイルを編集したらぶち転がすってコメント付けたい。