JSONi kommentaaride näide - kuidas kommenteerida JSON-failides

Kui teil on probleeme oma JSON-faili kommentaaride lisamisega, on sellel hea põhjus: JSON ei toeta kommentaare.

"Eemaldasin JSON-ist kommentaarid, kuna nägin, et inimesed kasutasid neid parsimisdirektiivide pidamiseks, mis oleks koostalitlusvõime hävitanud," kirjutab tekstipõhist andmevormingut populariseerinud Douglas Crockford.

Siiski on lahendus. Ja see on see artikkel: kuidas lisada kommentaare oma JSON-failile.

Andmete lisamine kommentaaridena

Kommentaariprobleemide lahendamiseks on vaja lisada oma JSON-faili andmeid, mis toimivad kommentaaridena.

Vaatame läbi näite, alustades sellest teabest meie JSON-failis:

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

Lisame nüüd veel ühe võtme-väärtuse paari, mis toimib meie kommentaarina, mida näete allpool oleva koodi esimesel real:

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

Siin on veel üks näide. Seekord kasutame võtme alguses ja lõpus kahte alljooni:

 "__comment2__": "this is another comment", 

Allakriipsud aitavad eristada kommentaari meie faili ülejäänud andmetest.

Ettevaatusega sõna

Pidage meeles olulist detaili.

JSON-faili lisatud kommentaarid lisatakse JSON-i objekti. Teisisõnu, kommentaare käsitletakse andmetena.

Siin me mõtleme seda.

See on meie faili kood data.json:

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

Nüüd loeme need andmed failist read_comments.py:

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

Tulemus sisaldab meie kommentaari:

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

Kommentaari väärtuse võime isegi JSON-objektist välja võtta this is my comment:

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

Pidage meeles, et kommentaar on ainult kommentaar arendaja silmis - mitte arvuti.

Erinevat tüüpi kommentaarid

See JSON-i kommenteerimispraktika erineb programmeerimiskeelte, näiteks Pythoni kommentaaridest, mida programmi käivitamisel tavaliselt eiratakse.

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

Kui käivitame ülaltoodud Pythoni programmi, saame tähed sõnas "maja". Kuid me ei näe kommentaari. Seda ignoreeritakse.

Kommenteerimisvalikud

JSMin on veel üks kaalumisvõimalus.

See on tööriist, mis eemaldab JavaScripti failidest täiendava tühiku ja kommentaarid. Kuid see töötab ka JSON-failide puhul. JSMin eemaldab JSON-failidest kommentaarid enne nende sõelumist.

Nii et JSON-failides kommenteerimiseks on võimalusi. Ehkki need pole täiuslikud lahendused, on vähemalt olemas viise vajaliku dokumentatsiooni lisamiseks.

Kirjutan programmeerimise õppimisest ja parimatest viisidest selle saavutamiseks ( amymhaddad.com).