JSONファイル内でコメントを使用することはできますか?できるとしたら、どのように?
いいえ。
JSONはすべてデータであるべきで、コメントを入れればそれもデータになります。
JSONデータを使用するアプリでは無視される"_comment"
(または何か)と呼ばれる指定のデータ要素を持つことができます。
JSONを生成・受信するプロセスでは、事前にJSONデータの内容や構造を知っているはずなので、コメントを入れた方が良いでしょう。
でも、もしそう決めたのなら
{
"_comment": "comment text goes here...",
"glossary": {
"title": "example glossary",
"GlossDiv": {
"title": "S",
"GlossList": {
"GlossEntry": {
"ID": "SGML",
"SortAs": "SGML",
"GlossTerm": "Standard Generalized Markup Language",
"Acronym": "SGML",
"Abbrev": "ISO 8879:1986",
"GlossDef": {
"para": "A meta-markup language, used to create markup languages such as DocBook.",
"GlossSeeAlso": ["GML", "XML"]
},
"GlossSee": "markup"
}
}
}
}
}
JSONの背景にある考え方は、アプリケーション間のシンプルなデータ交換を提供することです。これらは一般的にウェブベースで、言語はJavaScriptです。
しかし、コメントをデータの名前と値のペアの1つとして渡すことは可能ですが、そのデータは無視されるか、解析コードによって特別に処理される必要があります。
とはいえ、JSONファイルに伝統的な意味でのコメントが含まれることを意図しているわけではありません。ただのデータであるべきなのです。
詳しくは、JSON websiteをご覧ください。