JSONファイルにコメントを残せるようにしたJSONCというファイル形式を使おうか迷っているのですが、導入したことによる「問題・懸念・不便」はないのでしょうか？

テーマ・知りたいこと

JSONCというファイル形式を今後使うことで起こる「問題・懸念・不便」はないのかご意見いただきたいです。
※自身で調べてみたのですが情報が少なすぎて、JSONCを導入していいのか判断できませんでした。

背景

JSONファイルにコメントを残すためにこれまでは"$comment": "ここにコメントを記入"と書いていたのですが、先ほどJSONCというファイル形式があることを知り、この形式を使えばJSONファイルではあるのだがコメントを付けることができるとのことでした。
便利なので使いたいのですが、手放しに喜んで導入してはいけないなと思い自身でネットでJSONCについて調べたのですが情報が少なすぎて私では導入の判断ができなかったのでみなさんのご意見を頂きたいです。

回答5件

Zuishin

総合スコア28662

投稿2023/02/23 23:39

試しに導入してみたらわかるのでは？
パーサーさえ対応していればいいだけなので、パーサーを用意できるかどうかだけがネックになります。
つまりプロジェクト次第です。

maisumakun

総合スコア145201

投稿2023/02/24 00:13

JSONCとは少し違いますが、Babelの設定ファイルもJSON5という、JSONに対してコメントやシングルクオートなどが可能となる拡張が施されたパーサで処理しています。

そのように、JSONからの拡張が使われる例も見受けられます。

yambejp

総合スコア114968

投稿2023/02/24 02:01

方法論としては３つ
(1)JSONの形式を保ったままで特定のパラメーターに紐づけてコメントを付加する
(2)JSON形式を無視してコメントを付加して、受け側でテキストで受けた後コメントを削除したのちパースする
(3)拡張したJSONからコメントを外す専用のパーサーAPIを用意してそちら経由で拡張JSONに接続する

汎用性を考えれば(1)が現実的ですね
そもそもJSON自体が中間ファイルでしかないので、それにコメントを付加する必要があるかどうかです。