JSON にコメントを書く場合、いろいろあって
よく紹介されてるのが、、
Hjson ( .hjson )
https://hjson.github.io/
JSON5 ( .json5o )
https://json5.org/
JSONC ( .jsonc )
https://github.com/microsoft/node-jsonc-parser
Visual Studio Code 向け、
ですが、使用条件、環境に制約が生まれるなら、やはり、JSON書式ルールに
従う中でコメントを書くのが一番良い気がします。
(読み側がそのフィールドを無視すれば良いだけのこと)
{ "coment" : "#############################", "coment" : " コメント ", "coment" : "#############################", "id": 10012 }
Jackson では、コメントに対するフィールド名が未定義で
このまま読むと、UnrecognizedPropertyException を起こします。
com.fasterxml.jackson.databind.exc.UnrecognizedPropertyException: Unrecognized field
が起きるはずです。
Google gson で読込む場合は、未定義のJSONキー、フィールド名があろうが、
特に何もしなくても、無視してくれます。(そういうところが gson は嬉しいです。)
Jackson で未定義フィールドのある JSON を読み込む時の対応は2通りです。
@JsonIgnoreProperties を付ける
解析、マッピングされるクラスのアノテーションを付けて読込ます。
@JsonIgnoreProperties(ignoreUnknown=true) public class Sample {
ObjectMapper で設定
ObjectMapper mapper = new ObjectMapper(); mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);