Kommentare in JSON-Dateien?

JavaScript Object Notation (JSON) ist ein kompaktes Datenformat in Textform, das zum Austausch strukturierter Daten zwischen Anwendungen dient. Es basiert auf JavaScript, ist dennoch von der Programmiersprache unabhängig. Ein häufig auftauchendes Problem bzw. Frage ist: Kann man auch JSON-Kommentare in JSON-Dateien unterbringen?

Die kurze Antwort ist: nein. Die JSON Datei enthält nur Daten, deswegen ist es nicht möglich, Kommentare darin einzugeben, da sie auch als Daten interpretiert würden. Dennoch zeigt Ihnen dieser Artikel einen Workaround, mit dessen Hilfe es machbar ist.

JSON Struktur und Verwendung

Eine JSON Datei speichert Informationen wie Objekte, Arrays und sonstige Variablen in lesbarer Form.

Diese Variablen können folgende Typen haben:

  • Null – zeigt an, dass sich kein Wert in der Variable befindet.
  • Boolean – kann true (wahr) oder false (falsch) als Werte haben.
  • Zahl – besteht nur aus Ziffern (0-9) und, falls es nötig ist, einem Minus Vorzeichen oder einem Punkt.
  • Zeichenkette (String) – wird zwischen zwei doppelten Ausführungszeiten notiert.
  • Array enthält mehrere Werte, durch Kommas getrennt, in eckige Klammern ([]).
  • Objekt enthält mehrere Werte in geschweiften Klammern ({}). Jeder Wert muss einen eindeutigen Schlüssel haben, um darauf zuzugreifen. Ein Doppelpunkt trennt das Schlüssel-Werte-Paar und ein Komma trennt die Paare.

Weiterhin gibt es verschiedene Parser, die den JSON String in eine entsprechende Variable verwandeln.

Übrigens tauschen Server und Client Informationen untereinander mit Hilfe der JSON Datei aus. Auf dieser Weise kann eine Webseite zum Beispiel gewisse Daten anzeigen.

Einen JSON Objekt kann man als einfache  Textdatei mit der Endung .json speichern oder einen MIME type als application/json.

Dieses Format eine praktische Alternative zu XML.

LESEN SIE AUCH:  CTRL-Taste (PC und Laptop)
Client-Server JSON Datenaustausch

Lösung für JSON Kommentare

Obwohl Kommentare in JSON nicht erlaubt sind, gib es eine einfache Lösung bzw. einen Workaround dazu. Sie können ein Datenelement, das Sie zum Beispiel, “_comment” nennen, als Konvention einfügen. Alle Apps, die die JSON Datei benutzen, werden dieses Element ignorieren.

{
  "_comment": "Dieser Text ist ein Kommentar",
  "glossary": {
    "title": "Glossary",
    "GlossDiv": {
      "title": "S",
      "GlossList": {
        "GlossEntry": {
          "ID": "SGML",
          "SortAs": "SGML",
          "GlossTerm": "Standard Generalized Markup Language",
          "Acronym": "SGML",
          "Abbrev": "ISO 8879:1986",
          "GlossDef": {
            "para": "A meta-markup language, used to create markup languages such as DocBook.",
            "GlossSeeAlso": ["GML", "XML"]
          },
          "GlossSee": "markup"
        }
      }
    }
  }
}

Eine andere Methode wäre, den Kommentar in den Prozessen einzusetzen, die die JSON Datei generieren oder empfangen. Das könnte sogar eine bessere Lösung dafür sein.

FavoriteLoading Tipp meinen Favoriten hinzufügen (setzt Cookie, mehr unter Datenschutz)