Παράδειγμα σχολίων JSON - Τρόπος σχολιασμού σε αρχεία JSON

Εάν αντιμετωπίζετε προβλήματα με την προσθήκη σχολίων στο αρχείο JSON, υπάρχει ένας καλός λόγος: Το JSON δεν υποστηρίζει σχόλια.

«Κατάργησα τα σχόλια από την JSON επειδή είδα ότι οι άνθρωποι τα χρησιμοποιούσαν για να κρατήσουν οδηγίες ανάλυσης, μια πρακτική που θα είχε καταστρέψει τη διαλειτουργικότητα», γράφει ο Douglas Crockford, ο οποίος διαδόθηκε τη μορφή δεδομένων που βασίζεται σε κείμενο.

Ωστόσο, υπάρχει μια λύση. Και αυτό είναι το άρθρο: πώς να προσθέσετε σχόλια στο αρχείο 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 παραπάνω, λαμβάνουμε τα γράμματα στη λέξη "house". Αλλά δεν βλέπουμε το σχόλιο. Αγνοείται.

Επιλογές σχολιασμού

Το JSMin είναι μια άλλη επιλογή που πρέπει να λάβετε υπόψη.

Είναι ένα εργαλείο που αφαιρεί επιπλέον κενό διάστημα και σχόλια από αρχεία JavaScript. Αλλά λειτουργεί επίσης σε αρχεία JSON. Το JSMin αφαιρεί σχόλια από αρχεία JSON πριν αναλυθούν.

Υπάρχουν λοιπόν επιλογές όσον αφορά τον σχολιασμό σε αρχεία JSON. Αν και δεν είναι τέλειες λύσεις, τουλάχιστον υπάρχουν τρόποι για να συμπεριλάβετε την τεκμηρίωση που χρειάζεστε όταν τη χρειάζεστε.

Γράφω για την εκμάθηση του προγράμματος και τους καλύτερους τρόπους για να το κάνουμε ( amymhaddad.com).