Fun Fact: Es gibt keine offizielle Möglichkeit in JSON-Daten Kommentare unterzubringen.

Gerade als Entwicklerteam, dass sich erstmals mit JSON, Javascript und Client-Programmierung beschäftigt, sind Kommentare eine gute Möglichkeit sich zu erklären. Deshalb war ich überrascht, dass es tatsächlich keine Kommentare in JSON gibt.

In den ersten Versionen des Standards gab es zwar Kommentare, aber nachdem Douglas Crockford nicht gefiel, was die Leute mit Kommentaren anstellten, hat er sie ersatzlos aus dem Standard entfernt.

Nichtsdestotrotz halte ich diese Entscheidung für völlig falsch. Es ist für mich einfach völlig unverständlich warum z.B. in einer “package.json”-Konfigurationsdatei keinerlei Kommentare möglich sind, um bestimmte Einstellungen anderen Entwicklern zu erklären.

Als Konvention könnte man sich aber z.B. darauf einigen, Kommentare in der Datenstruktur selbst unterzubringen und diese Daten einfach nicht verarbeiten. Beispiel:

{
   "__comment" : "Das hier ist ein Kommentar",
   "success" : true,
   "data": {
      "title": "Es",
      "author": "Stephen King", 
      "isbn": "1234567890"
   }
}

Für Puristen sicher ein Graus, aber leider so ziemlich die einzige Möglichkeit.

Eine längere Abhandlung und auch eine Erklärung der Historie findet sich im getiblog