Articolo originale: https://www.freecodecamp.org/news/json-comment-example-how-to-comment-in-json-files/

Se hai problemi ad aggiungere commenti al tuo file JSON, c'è una buona ragione: JSON non supporta i commenti.

"Ho rimosso i commenti da JSON perché ho visto che le persone li usavano per mantenere le direttive di analisi, una pratica che avrebbe distrutto l'interoperabilità", scrive Douglas Crockford , che ha reso popolare il formato dei dati basato su testo.

Tuttavia, c'è una soluzione alternativa. Ed è di questo che tratta questo articolo: come aggiungere commenti al tuo file JSON.

Aggiungi dati come commenti

Un modo per aggirare il problema dei commenti è aggiungere dati al file JSON che funzionano come commenti.

Esaminiamo un esempio, partendo da queste informazioni nel nostro file JSON:

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


Ora aggiungiamo un'altra coppia chiave-valore da utilizzare come nostro commento, che puoi vedere nella prima riga del codice qui sotto:

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

Ecco un altro esempio. Questa volta, utilizziamo due caratteri di sottolineatura all'inizio e alla fine della chiave:

 "__comment2__": "this is another comment",

I trattini bassi aiutano a differenziare il commento dal resto dei dati nel nostro file.

Una parola di avvertimento

C'è un dettaglio importante da tenere a mente.

I commenti che abbiamo aggiunto al nostro file JSON sono inclusi nell'oggetto JSON. In altre parole, i commenti vengono trattati come dati.

Ecco cosa intendiamo.

Questo è il codice nel nostro file data.json:

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

Ora leggeremo quei dati dal file : read_comments.py

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

Il risultato include il nostro commento:

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

Possiamo anche estrarre il valore del commento dall'oggetto JSON: this is my comment:

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

Tieni presente che il commento è solo un commento agli occhi dello sviluppatore, non del computer.

Un diverso tipo di commento

Questa pratica di commento JSON è diversa dai commenti nei linguaggi di programmazione, come Python, che in genere vengono ignorati durante l'esecuzione del programma.

# Qui è il mio commento
word = "casa"
for letter in word:
   print(letter)

Quando eseguiamo questo frammento di codice in Python, otteniamo la stringa   "casa" nella variabile word. Ma non vediamo il commento. È ignorato.

Opzioni di commento

JSMin è un'altra opzione da considerare.

È uno strumento che rimuove gli spazi bianchi e i commenti aggiuntivi dai file JavaScript. Ma funziona anche su file JSON. JSMin rimuove i commenti dai file JSON prima che vengano analizzati.

Quindi ci sono più opzioni quando si tratta di commentare nei file JSON. Sebbene non siano soluzioni perfette, almeno ci sono modi per includere la documentazione di cui hai bisogno quando ne hai bisogno.

Scrivo sull'apprendimento della programmazione e sui modi migliori per farlo ( amymhaddad.com ).