Пример за JSON коментар - Как да коментирате в JSON файлове

Ако имате проблеми с добавянето на коментари към вашия JSON файл, има основателна причина: JSON не поддържа коментари.

„Премахнах коментари от JSON, защото видях, че хората ги използват, за да държат директиви за синтактичен анализ, практика, която би унищожила оперативната съвместимост“, пише Дъглас Крокфорд, който популяризира текстовия формат на данните.

Има обаче заобиколно решение. И за това е тази статия: как да добавите коментари към вашия 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 } 

Ето още един пример. Този път използваме две долни черти в началото и края на ключа:

 "__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 е друга възможност за разглеждане.

Това е инструмент, който премахва допълнително празно пространство и коментари от JavaScript файлове. Но работи и върху JSON файлове. JSMin премахва коментари от JSON файлове, преди да бъдат анализирани.

Така че има опции, когато става въпрос за коментиране в JSON файлове. Въпреки че те не са перфектни решения, поне има начини да включите необходимата документация, когато имате нужда от нея.

Пиша за ученето да програмирам и за най-добрите начини да го направя ( amymhaddad.com).