Приклад коментаря 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).