JSONコメントの例—JSONファイルでコメントする方法

JSONファイルにコメントを追加する際に問題が発生した場合は、正当な理由があります。JSONはコメントをサポートしていません。

「JSONからコメントを削除したのは、相互運用性を破壊するような構文解析ディレクティブを保持するためにコメントを使用しているのを見たからです」と、テキストベースのデータ形式を普及させたDouglasCrockfordは書いています。

ただし、回避策があります。そして、それがこの記事の内容です。JSONファイルにコメントを追加する方法です。

コメントとしてデータを追加

コメントの問題を回避する方法は、コメントとして機能するデータをJSONファイルに追加することです。

JSONファイルのこの情報から始めて、例を見てみましょう。

{ "sport": "basketball", "coach": "Joe Smith", "wins": 15, "losses": 5 } 

次に、コメントとして機能する別のキーと値のペアを追加しましょう。これは、以下のコードの最初の行に表示されています。

{ "_comment1": "this is my comment", "sport": "basketball", "coach": "Joe Smith", "wins": 15, "losses": 5 } 

別の例を示します。今回は、キーの最初と最後に2つのアンダースコアを使用します。

 "__comment2__": "this is another comment", 

下線は、コメントをファイル内の残りのデータと区別するのに役立ちます。

注意の言葉

覚えておくべき重要な詳細があります。

JSONファイルに追加したコメントは、JSONオブジェクトに含まれています。つまり、コメントはデータとして扱われます。

これが私たちの意味です。

これは私たちのファイルのコードですdata.json

{ "_comment1": "this is my comment", "sport": "basketball", "coach": "Joe Smith", "wins": 15, "losses": 5 } 

次に、ファイルからそのデータを読み取りますread_comments.py

import json with open("data.json", mode="r") as j_object: data = json.load(j_object) print(data) 

結果には私たちのコメントが含まれています:

{'_comment1': 'this is my comment', 'sport': 'basketball', 'coach': 'Joe Smith', 'wins': 15, 'losses': 5} 

JSONオブジェクトからコメントの値を抽出することもできますthis is my comment::

import json with open("data.json", mode="r") as j_object: data = json.load(j_object) print(data["_comment1"]) 

コメントは開発者の目から見たコメントであり、コンピューターではないことに注意してください。

別の種類のコメント

このJSONコメントの練習は、プログラムの実行時に通常無視されるPythonなどのプログラミング言語のコメントとは異なります。

# Here's my comment word = "house" for letter in word: print(letter) 

上記のPythonプログラムを実行すると、「家」という単語の文字が表示されます。しかし、コメントは表示されません。無視されます。

コメントオプション

JSMinは考慮すべきもう1つのオプションです。

これは、JavaScriptファイルから余分な空白とコメントを削除するツールです。ただし、JSONファイルでも機能します。JSMinは、コメントが解析される前に、JSONファイルからコメントを削除します。

したがって、JSONファイルでのコメントに関してはオプションがあります。これらは完全なソリューションではありませんが、少なくとも、必要なときに必要なドキュメントを含める方法があります。

私はプログラムを学ぶこととそれを実行するための最良の方法について書いています( amymhaddad.com)。