I commenti tornano molto comodi in diverse situazioni, anche all’interno dei JSON. La domanda è: possiamo usare i commenti nel JSON? Lo scopriremo assieme in questo articolo!
Prima di tutto, il formato JSON è nato per contenere dati: non è stato pensato per fornire informazioni di contorno all’utente finale oppure a seguito delle invocazioni API di qualche servizio.
Di conseguenza non è stato pensato per integrare commenti al suo interno.
Ciao mi chiamo Lorenzo Neri e sono un informatico: realizzo contenuti per aiutare le persone a padroneggiare l’arte del nuovo millennio, ovvero l’informatica!
Possiamo “parafrasare” la frase di prima sotto un altro punto di vista:
All’interno di un file JSON tutti i contenuti sono dati, di conseguenza lo sarà anche il commento che vuoi aggiungere.
Se devo darti una risposta precisa e diretta, sarebbe “No, non si possono usare i commenti nel JSON”.
Ma non è funzionale e se rileggi due frasi prima, c’è un “trucchetto” 😉
Come usare i commenti nel JSON
Il trucchetto stupido che sta alla base di quello che ho detto prima, è trattare il commento come un dato informativo dentro il JSON stesso!
Perciò, quello che possiamo fare, è aggiungere una chiave ben specifica all’interno del file con associato come valore il commento stesso.
Facciamo un esempio molto banale, partiamo da un JSON base:
{
"ID":"1234567889",
"email":"prova@prova.it",
"commenti": ["ciao", "prova","sto provando i commenti"]
}
Ammettiamo di voler aggiungere un commento che reciti “API in fase di test, non è il risultato finale!”:
{
"__comment":"API in fase di test, non è il risultato finale!",
"ID":"1234567889",
"email":"prova@prova.it",
"commenti": ["ciao", "prova","sto provando i commenti"]
}
Se ci fai caso, non ho usato una parola ordinaria, ma l’ho fatta precedere da due underscore: per far capire agli utilizzatori finali del JSON che quello non è un dato vero e proprio ma un commento aggiuntivo che ho fatto io ed è totalmente svincolato dai dati presenti nel file!
Concludendo, la risposta alla domanda di questo articolo sarebbe un “NO” secco, eppure abbiamo visto che possiamo usare i commenti nel JSON da un punto di vista più “smart”: sia mai che possano tornare comodi a te e ai tuoi colleghi quando state testando delle API e volete evitare pasticci 😉
