Exemple de commentaire JSON - Comment commenter dans des fichiers JSON

Si vous rencontrez des difficultés pour ajouter des commentaires à votre fichier JSON, il y a une bonne raison: JSON ne prend pas en charge les commentaires.

«J'ai supprimé les commentaires de JSON parce que j'ai vu que les gens les utilisaient pour contenir des directives d'analyse, une pratique qui aurait détruit l'interopérabilité», écrit Douglas Crockford, qui a popularisé le format de données basé sur du texte.

Cependant, il existe une solution de contournement. Et c'est le sujet de cet article: comment ajouter des commentaires à votre fichier JSON.

Ajouter des données en tant que commentaires

Un moyen de contourner le problème des commentaires consiste à ajouter des données à votre fichier JSON qui fonctionnent comme des commentaires.

Passons en revue un exemple, en commençant par ces informations dans notre fichier JSON:

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

Maintenant, ajoutons une autre paire clé-valeur pour servir de commentaire, que vous pouvez voir dans la première ligne du code ci-dessous:

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

Voici un autre exemple. Cette fois, nous utilisons deux traits de soulignement au début et à la fin de la clé:

 "__comment2__": "this is another comment", 

Les traits de soulignement aident à différencier le commentaire du reste des données de notre fichier.

Un mot d'avertissement

Il y a un détail important à garder à l'esprit.

Les commentaires que nous avons ajoutés à notre fichier JSON sont inclus dans l'objet JSON. En d'autres termes, les commentaires sont traités comme des données.

Voici ce que nous voulons dire.

Voici le code dans notre fichier data.json,:

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

Nous allons maintenant lire ces données à partir du fichier read_comments.py,:

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

Le résultat comprend notre commentaire:

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

Nous pouvons même extraire la valeur du commentaire de l'objet JSON this is my comment::

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

Gardez à l'esprit que le commentaire n'est qu'un commentaire aux yeux du développeur, et non de l'ordinateur.

Un autre type de commentaire

Cette pratique de commentaire JSON est différente des commentaires dans les langages de programmation, comme Python, qui sont généralement ignorés lorsque le programme s'exécute.

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

Lorsque nous exécutons le programme Python ci-dessus, nous obtenons les lettres du mot «maison». Mais nous ne voyons pas le commentaire. C'est ignoré.

Options de commentaire

JSMin est une autre option à considérer.

C'est un outil qui supprime les espaces et les commentaires supplémentaires des fichiers JavaScript. Mais cela fonctionne également sur les fichiers JSON. JSMin supprime les commentaires des fichiers JSON avant leur analyse.

Il existe donc des options pour commenter les fichiers JSON. Bien qu'il ne s'agisse pas de solutions parfaites, il existe au moins des moyens d'inclure la documentation dont vous avez besoin lorsque vous en avez besoin.

J'écris sur l'apprentissage de la programmation et les meilleures façons de s'y prendre ( amymhaddad.com).