Dacă aveți probleme cu adăugarea de comentarii la fișierul dvs. JSON, există un motiv întemeiat: JSON nu acceptă comentarii.

„Am eliminat comentariile din JSON pentru că am văzut că oamenii le foloseau pentru a ține directive de analiză, o practică care ar fi distrus interoperabilitatea”, scrie Douglas Crockford, care a popularizat formatul de date bazat pe text.

Cu toate acestea, există o soluție. Și despre asta este vorba în acest articol: cum să adăugați comentarii la fișierul dvs. JSON.

Adăugați date ca comentarii

O modalitate de a rezolva problema comentariilor este să adăugați date în fișierul dvs. JSON care funcționează ca comentarii.

Să parcurgem un exemplu, începând cu aceste informații în fișierul nostru JSON:

ad-banner

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

Acum să adăugăm o altă pereche cheie-valoare pentru a ne servi drept comentariu, pe care o puteți vedea în prima linie din codul de mai jos:

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

Iată un alt exemplu. De data aceasta, folosim două puncte de subliniere la începutul și la sfârșitul cheii:

 "__comment2__": "this is another comment",

Sublinierile ajută la diferențierea comentariului de restul datelor din fișierul nostru.

Un Cuvânt de Atenție

Există un detaliu important de reținut.

Comentariile pe care le-am adăugat în fișierul nostru JSON sunt incluse în obiectul JSON. Cu alte cuvinte, comentariile sunt tratate ca date.

Iată la ce ne referim.

Acesta este codul din fișierul nostru, data.json:

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

Acum vom citi aceste date din fișier, read_comments.py:

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

Rezultatul include comentariul nostru:

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

Putem chiar extrage valoarea comentariului din obiectul JSON: this is my comment:

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

Rețineți că comentariul este doar un comentariu în ochii dezvoltatorului – nu al computerului.

Un tip diferit de comentariu

Această practică de comentare JSON este diferită de comentariile din limbaje de programare, cum ar fi Python, care sunt de obicei ignorate când rulează programul.

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

Când rulăm programul Python de mai sus, primim literele din cuvântul „casă”. Dar nu vedem comentariul. Este ignorat.

Opțiuni de comentare

JSMin este o altă opțiune de luat în considerare.

Este un instrument care elimină spațiul alb suplimentar și comentariile din fișierele JavaScript. Dar funcționează și pe fișiere JSON. JSMin elimină comentariile din fișierele JSON înainte de a fi analizate.

Deci, există opțiuni atunci când vine vorba de comentarea în fișiere JSON. Deși nu sunt soluții perfecte, cel puțin există modalități de a include documentația de care aveți nevoie atunci când aveți nevoie de ea.

Scriu despre învățarea programării și despre cele mai bune modalități de a face acest lucru (amymhaddad.com).