So fügen Sie Ihrer JSON-Datei Kommentare hinzu

Blog

So fügen Sie Ihrer JSON-Datei Kommentare hinzu

So fügen Sie Ihrer JSON-Datei Kommentare hinzu

Wenn Sie Probleme beim Hinzufügen von Kommentaren zu Ihrer JSON-Datei haben, gibt es einen guten Grund: JSON unterstützt keine Kommentare.



Ich habe Kommentare aus JSON entfernt, weil ich gesehen habe, dass Leute sie verwenden, um Parsing-Direktiven zu halten, eine Praxis, die die Interoperabilität zerstört hätte, schreibt Douglas Crockford , der das textbasierte Datenformat populär gemacht hat.

Es gibt jedoch einen Workaround. Und darum geht es in diesem Artikel: wie Sie Ihrer JSON-Datei Kommentare hinzufügen.



Daten als Kommentare hinzufügen

Eine Möglichkeit, das Kommentarproblem zu umgehen, besteht darin, Ihrer JSON-Datei Daten hinzuzufügen, die als Kommentare fungieren.

Lassen Sie uns ein Beispiel durchgehen, beginnend mit diesen Informationen in unserer JSON-Datei:



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

Fügen wir nun ein weiteres Schlüssel-Wert-Paar als Kommentar hinzu, das Sie in der ersten Zeile des folgenden Codes sehen können:

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

Hier ist ein weiteres Beispiel. Diesmal verwenden wir zwei Unterstriche am Anfang und am Ende des Schlüssels:

'__comment2__': 'this is another comment',

Die Unterstriche helfen, den Kommentar von den restlichen Daten in unserer Datei zu unterscheiden.

Ein Wort der Vorsicht

Es gibt ein wichtiges Detail, das Sie beachten sollten.

Die Kommentare, die wir unserer JSON-Datei hinzugefügt haben, sind im JSON-Objekt enthalten. Mit anderen Worten, die Kommentare werden als Daten behandelt.

Hier ist, was wir meinen.

Dies ist der Code in unserer Datei, data.json :

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

Jetzt lesen wir diese Daten aus der Datei, read_comments.py :

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

Das Ergebnis beinhaltet unseren Kommentar:

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

Wir können sogar den Wert des Kommentars aus dem JSON-Objekt extrahieren: |_+_|:

this is my comment

Denken Sie daran, dass der Kommentar nur ein Kommentar in den Augen des Entwicklers ist – nicht des Computers.

Eine andere Art von Kommentar

Diese JSON-Kommentarpraxis unterscheidet sich von Kommentaren in Programmiersprachen wie Python, die normalerweise ignoriert werden, wenn das Programm ausgeführt wird.

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

Wenn wir das obige Python-Programm ausführen, erhalten wir die Buchstaben im Wort house. Aber wir sehen den Kommentar nicht. Es wird ignoriert.

Kommentaroptionen

JSMin ist eine weitere Option, die in Betracht gezogen werden sollte.

Es ist ein Tool, das zusätzlichen Leerraum und Kommentare aus JavaScript-Dateien entfernt. Aber es funktioniert auch mit JSON-Dateien. JSMin entfernt Kommentare aus JSON-Dateien, bevor sie geparst werden.

Es gibt also Optionen, wenn es um das Kommentieren in JSON-Dateien geht. Obwohl es sich nicht um perfekte Lösungen handelt, gibt es zumindest Möglichkeiten, die benötigte Dokumentation bei Bedarf einzufügen.

#json #javascript #web-entwicklung

Klasse 'app\http\controllers\db' nicht gefunden