Können Kommentare in JSON verwendet werden?

Kann ich Kommentare in einer JSON-Datei verwenden? Wenn das so ist, wie?

Nein.

Der JSON sollte alle Daten sein, und wenn Sie einen Kommentar einfügen, sind es auch Daten.

Möglicherweise haben Sie ein bestimmtes Datenelement namens "_comment"(oder etwas anderes), das von Apps, die die JSON-Daten verwenden, ignoriert wird.

Sie sollten den Kommentar wahrscheinlich besser in den Prozessen haben, die den JSON generieren / empfangen, da sie im Voraus wissen sollen, wie die JSON-Daten aussehen werden, oder zumindest deren Struktur.

Aber wenn Sie sich entschieden haben:

{
   "_comment": "comment text goes here...",
   "glossary": {
      "title": "example 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"
            }
         }
      }
   }
}

Nein , Kommentare des Formulars //…oder /*…*/sind in JSON nicht zulässig. Diese Antwort basiert auf:

• http://www.json.org
• RFC 4627 : Der application/jsonMedientyp für die JavaScript-Objektnotation (JSON)
• RFC 8259 Das JSON-Datenaustauschformat (JavaScript Object Notation) (ersetzt die RFCs 4627, 7158, 7159)

Fügen Sie Kommentare hinzu, wenn Sie möchten. Entfernen Sie sie mit einem Minifier, bevor Sie sie analysieren oder senden.

Ich habe gerade JSON.minify () veröffentlicht, das Kommentare und Leerzeichen aus einem JSON-Block entfernt und es zu einem gültigen JSON macht, das analysiert werden kann. Sie können es also wie folgt verwenden:

JSON.parse(JSON.minify(my_str));

Als ich es veröffentlichte, gab es eine große Gegenreaktion von Leuten, die nicht einmal mit der Idee einverstanden waren. Deshalb beschloss ich, einen umfassenden Blog-Beitrag darüber zu schreiben, warum Kommentare in JSON sinnvoll sind . Es enthält diesen bemerkenswerten Kommentar des Erstellers von JSON:

Angenommen, Sie verwenden JSON, um Konfigurationsdateien zu speichern, die Sie mit Anmerkungen versehen möchten. Fügen Sie alle gewünschten Kommentare ein. Führen Sie es dann durch JSMin, bevor Sie es an Ihren JSON-Parser übergeben. - Douglas Crockford, 2012

Hoffentlich ist das hilfreich für diejenigen, die nicht damit einverstanden sind, warum JSON.minify () nützlich sein könnte.

Kommentare wurden von Entwurf aus JSON entfernt.

Ich habe Kommentare aus JSON entfernt, weil ich gesehen habe, dass Leute sie zum Parsen von Anweisungen verwenden, eine Praxis, die die Interoperabilität zerstört hätte. Ich weiß, dass das Fehlen von Kommentaren einige Leute traurig macht, aber es sollte nicht.

Angenommen, Sie verwenden JSON, um Konfigurationsdateien zu speichern, die Sie mit Anmerkungen versehen möchten. Fügen Sie alle gewünschten Kommentare ein. Führen Sie es dann durch JSMin, bevor Sie es an Ihren JSON-Parser übergeben.

Quelle: Öffentliche Erklärung von Douglas Crockford zu G +

HAFTUNGSAUSSCHLUSS: IHRE GARANTIE IST NICHTIG

Wie bereits erwähnt, nutzt dieser Hack die Implementierung der Spezifikation. Nicht alle JSON-Parser werden diese Art von JSON verstehen. Insbesondere Streaming-Parser werden ersticken.

Es ist eine interessante Kuriosität, aber Sie sollten es wirklich für nichts verwenden . Unten ist die ursprüngliche Antwort.

Ich habe einen kleinen Hack gefunden, mit dem Sie Kommentare in eine JSON-Datei einfügen können, die sich nicht auf das Parsen auswirken oder die dargestellten Daten in irgendeiner Weise ändern.

Es scheint, dass Sie beim Deklarieren eines Objektliteral zwei Werte mit demselben Schlüssel angeben können, wobei der letzte Vorrang hat. Ob Sie es glauben oder nicht, es stellt sich heraus, dass JSON-Parser genauso funktionieren. Damit können wir Kommentare im Quell-JSON erstellen, die in einer analysierten Objektdarstellung nicht vorhanden sind.

({a: 1, a: 2});
// => Object {a: 2}
Object.keys(JSON.parse('{"a": 1, "a": 2}')).length; 
// => 1

Wenn wir diese Technik anwenden, sieht Ihre kommentierte JSON-Datei möglicherweise folgendermaßen aus:

{
  "api_host" : "The hostname of your API server. You may also specify the port.",
  "api_host" : "hodorhodor.com",

  "retry_interval" : "The interval in seconds between retrying failed API calls",
  "retry_interval" : 10,

  "auth_token" : "The authentication token. It is available in your developer dashboard under 'Settings'",
  "auth_token" : "5ad0eb93697215bc0d48a7b69aa6fb8b",

  "favorite_numbers": "An array containing my all-time favorite numbers",
  "favorite_numbers": [19, 13, 53]
}

Der obige Code ist gültiger JSON . Wenn Sie es analysieren, erhalten Sie ein Objekt wie das folgende:

{
    "api_host": "hodorhodor.com",
    "retry_interval": 10,
    "auth_token": "5ad0eb93697215bc0d48a7b69aa6fb8b",
    "favorite_numbers": [19,13,53]
}

Das heißt, es gibt keine Spur von Kommentaren und sie werden keine seltsamen Nebenwirkungen haben.

Viel Spaß beim Hacken!

JSON unterstützt keine Kommentare. Es war auch nie für Konfigurationsdateien vorgesehen, bei denen Kommentare erforderlich wären.

Hjson ist ein Konfigurationsdateiformat für Menschen. Entspannte Syntax, weniger Fehler, mehr Kommentare.

Unter hjson.org finden Sie JavaScript-, Java-, Python-, PHP-, Rust- , Go-, Ruby- und C # -Bibliotheken.

Erwägen Sie die Verwendung von YAML. Es ist fast eine Obermenge von JSON (praktisch alle gültigen JSONs sind gültige YAML) und es erlaubt Kommentare.

Das kannst du nicht. Zumindest ist das meine Erfahrung aus einem kurzen Blick auf json.org .

Die Syntax von JSON wird auf dieser Seite visualisiert. Es gibt keinen Hinweis zu Kommentaren.

Kommentare sind kein offizieller Standard, obwohl einige Parser Kommentare im C ++ - Stil unterstützen. Eine, die ich benutze, ist JsonCpp . In den Beispielen gibt es dieses:

// Configuration options
{
    // Default encoding for text
    "encoding" : "UTF-8",

    // Plug-ins loaded at start-up
    "plug-ins" : [
        "python",
        "c++",
        "ruby"
        ],

    // Tab indent size
    "indent" : { "length" : 3, "use_space": true }
}

jsonlint validiert dies nicht. Kommentare sind also eine parser-spezifische Erweiterung und kein Standard.

Ein weiterer Parser ist JSON5 .

Eine Alternative zu JSON TOML .

Eine weitere Alternative ist jsonc .

Sie sollten stattdessen ein JSON-Schema schreiben . Das JSON-Schema ist derzeit eine vorgeschlagene Internet-Entwurfsspezifikation. Neben der Dokumentation kann das Schema auch zur Validierung Ihrer JSON-Daten verwendet werden.

Beispiel:

{
    "description":"A person",
    "type":"object",
    "properties":
        {
            "name":
                {
                    "type":"string"
                },
            "age":
                {
                    "type":"integer",
                    "maximum":125
                }
        }
}

Sie können die Dokumentation mithilfe des Beschreibungsschemaattributs bereitstellen .

Wenn Sie Jackson als JSON-Parser verwenden, können Sie auf folgende Weise Kommentare zulassen:

ObjectMapper mapper = new ObjectMapper().configure(Feature.ALLOW_COMMENTS, true);

Dann können Sie Kommentare wie diese haben:

{
  key: "value" // Comment
}

Und Sie können auch Kommentare haben, #indem Sie Folgendes einstellen:

mapper.configure(Feature.ALLOW_YAML_COMMENTS, true);

Im Allgemeinen (wie zuvor beantwortet) erlaubt die Spezifikation jedoch keine Kommentare.

Folgendes habe ich in der Google Firebase-Dokumentation gefunden , mit der Sie Kommentare in JSON einfügen können:

{
  "//": "Some browsers will use this to enable push notifications.",
  "//": "It is the same for all projects, this is not your project's sender ID",
  "gcm_sender_id": "1234567890"
}

NEIN . JSON unterstützte früher Kommentare, diese wurden jedoch missbraucht und aus dem Standard entfernt.

Vom Schöpfer von JSON:

Ich habe Kommentare aus JSON entfernt, weil ich gesehen habe, dass Leute sie zum Parsen von Direktiven verwenden, eine Praxis, die die Interoperabilität zerstört hätte. Ich weiß, dass das Fehlen von Kommentaren einige Leute traurig macht, aber es sollte nicht. - Douglas Crockford, 2012

Die offizielle JSON-Site befindet sich unter JSON.org . JSON wird von ECMA International als Standard definiert . Es gibt immer ein Petitionsverfahren, um Standards zu überarbeiten. Es ist aus mehreren Gründen unwahrscheinlich, dass dem JSON-Standard Anmerkungen hinzugefügt werden.

JSON ist von Natur aus eine einfach rückentwickelte (vom Menschen analysierte) Alternative zu XML. Es wird sogar so weit vereinfacht, dass Anmerkungen nicht erforderlich sind. Es ist nicht einmal eine Auszeichnungssprache. Das Ziel ist Stabilität und Interoperabilität.

Jeder, der die "has-a" -Beziehung der Objektorientierung versteht, kann jede JSON-Struktur verstehen - das ist der springende Punkt. Es ist nur ein gerichteter azyklischer Graph (DAG) mit Knoten-Tags (Schlüssel / Wert-Paare), der eine nahezu universelle Datenstruktur darstellt.

Diese einzige erforderliche Annotation könnte "// Dies sind DAG-Tags" sein. Die Schlüsselnamen können so informativ wie erforderlich sein und eine beliebige semantische Arität ermöglichen.

Jede Plattform kann JSON mit nur wenigen Codezeilen analysieren. XML erfordert komplexe OO-Bibliotheken, die auf vielen Plattformen nicht funktionsfähig sind.

Anmerkungen würden JSON nur weniger interoperabel machen. Es gibt einfach nichts anderes hinzuzufügen, es sei denn, Sie benötigen wirklich eine Auszeichnungssprache (XML), und es ist Ihnen egal, ob Ihre persistierten Daten leicht analysiert werden können.

ABER wie der Schöpfer von JSON auch bemerkte, gab es immer Unterstützung für JS-Pipelines für Kommentare:

Fügen Sie alle gewünschten Kommentare ein. Führen Sie es dann durch JSMin, bevor Sie es an Ihren JSON-Parser übergeben. - Douglas Crockford, 2012

Wenn Ihre Textdatei, bei der es sich um eine JSON-Zeichenfolge handelt, von einem Programm gelesen wird, wie schwierig wäre es dann, Kommentare im C- oder C ++ - Stil zu entfernen, bevor Sie sie verwenden?

Antwort: Es wäre ein Einzeiler. Wenn Sie dies tun, können JSON-Dateien als Konfigurationsdateien verwendet werden.

Wenn Sie die Newtonsoft.Json-Bibliothek mit ASP.NET zum Lesen / Deserialisieren verwenden, können Sie Kommentare im JSON-Inhalt verwenden:

// "name": "string"

// "id": int

oder

/* Das ist ein

Kommentarbeispiel * /

PS: Einzeilige Kommentare werden nur mit mehr als 6 Versionen von Newtonsoft Json unterstützt.

Zusätzlicher Hinweis für Leute, die nicht über den Tellerrand hinaus denken können: Ich verwende das JSON-Format für Grundeinstellungen in einer von mir erstellten ASP.NET-Webanwendung. Ich lese die Datei, konvertiere sie in das Einstellungsobjekt mit der Newtonsoft-Bibliothek und verwende sie bei Bedarf.

Ich schreibe lieber Kommentare zu jeder einzelnen Einstellung in die JSON-Datei selbst und kümmere mich wirklich nicht um die Integrität des JSON-Formats, solange die von mir verwendete Bibliothek damit einverstanden ist.

Ich denke, dies ist eine "einfacher zu verwendende / zu verstehende" Methode, als eine separate "settings.README" -Datei zu erstellen und die darin enthaltenen Einstellungen zu erläutern.

Wenn Sie ein Problem mit dieser Art der Verwendung haben; Entschuldigung, der Geist ist aus der Lampe. Die Leute würden andere Verwendungen für das JSON-Format finden, und Sie können nichts dagegen tun.

Die Idee hinter JSON ist es, einen einfachen Datenaustausch zwischen Anwendungen bereitzustellen. Diese sind normalerweise webbasiert und die Sprache ist JavaScript.

Kommentare als solche sind nicht wirklich zulässig. Das Übergeben eines Kommentars als eines der Name / Wert-Paare in den Daten würde jedoch sicherlich funktionieren, obwohl diese Daten offensichtlich vom Parsing-Code ignoriert oder speziell behandelt werden müssten.

Alles in allem ist es nicht beabsichtigt, dass die JSON-Datei Kommentare im herkömmlichen Sinne enthält. Es sollten nur die Daten sein.

Weitere Informationen finden Sie auf der JSON-Website .

Ich habe dies nur für Konfigurationsdateien festgestellt. Ich möchte kein XML-Format (ausführlich, grafisch, hässlich, schwer lesbar), kein "ini" -Format (keine Hierarchie, kein realer Standard usw.) oder kein Java-Format "Properties" (wie .ini) verwenden.

JSON kann alles, was sie können, aber es ist viel weniger ausführlich und besser lesbar - und Parser sind in vielen Sprachen einfach und allgegenwärtig. Es ist nur ein Datenbaum. Out-of-Band-Kommentare sind jedoch häufig eine Notwendigkeit, um "Standard" -Konfigurationen und dergleichen zu dokumentieren. Konfigurationen dürfen niemals "vollständige Dokumente" sein, sondern Bäume gespeicherter Daten, die bei Bedarf von Menschen gelesen werden können.

Ich denke, man könnte "#": "comment"für "gültiges" JSON verwenden.

JSON unterstützt Kommentare nicht nativ, aber Sie können Ihren eigenen Decoder oder zumindest Präprozessor erstellen, um Kommentare zu entfernen. Das ist vollkommen in Ordnung (solange Sie Kommentare einfach ignorieren und sie nicht als Leitfaden für die Verarbeitung der JSON-Daten durch Ihre Anwendung verwenden ).

JSON hat keine Kommentare. Ein JSON-Encoder darf KEINE Kommentare ausgeben. Ein JSON-Decoder kann Kommentare akzeptieren und ignorieren.

Kommentare sollten niemals verwendet werden, um etwas Sinnvolles zu übermitteln. Dafür ist JSON da.

Vgl.: Douglas Crockford, Autor der JSON-Spezifikation .

Dies hängt von Ihrer JSON-Bibliothek ab. Json.NET unterstützt Kommentare im JavaScript-Stil /* commment */.

Siehe eine weitere Frage zum Stapelüberlauf .

JSON ist für Konfigurationsdateien und andere lokale Anwendungen sehr sinnvoll, da es allgegenwärtig und viel einfacher als XML ist.

Wenn Personen starke Gründe haben, bei der Übermittlung von Daten Kommentare in JSON zu haben (ob gültig oder nicht), kann JSON möglicherweise in zwei Teile geteilt werden:

• JSON-COM: JSON auf dem Draht oder Regeln, die für die Kommunikation von JSON-Daten gelten.
• JSON-DOC: JSON-Dokument oder JSON in Dateien oder lokal. Regeln, die ein gültiges JSON-Dokument definieren.

JSON-DOC erlaubt Kommentare, und es können andere geringfügige Unterschiede bestehen, z. B. die Behandlung von Leerzeichen. Parser können problemlos von einer Spezifikation in die andere konvertiert werden.

In Bezug auf die Bemerkung von Douglas Crockford zu diesem Thema (verwiesen von @Artur Czajka)

Angenommen, Sie verwenden JSON, um Konfigurationsdateien zu speichern, die Sie mit Anmerkungen versehen möchten. Fügen Sie alle gewünschten Kommentare ein. Führen Sie es dann durch JSMin, bevor Sie es an Ihren JSON-Parser übergeben.

Wir sprechen über ein generisches Problem mit Konfigurationsdateien (sprachübergreifend / plattformübergreifend) und er antwortet mit einem JS-spezifischen Dienstprogramm!

Sicher, ein JSON-spezifisches Minify kann in jeder Sprache implementiert werden, aber standardisieren Sie es so, dass es für Parser in allen Sprachen und Plattformen allgegenwärtig ist, sodass die Benutzer keine Zeit mehr damit verschwenden, die Funktion zu verpassen, weil sie gute Anwendungsfälle dafür haben und das Problem nachschlagen Online-Foren und die Leute dazu bringen, ihnen zu sagen, dass es eine schlechte Idee ist oder dass es einfach ist, das Entfernen von Kommentaren aus Textdateien zu implementieren.

Das andere Problem ist die Interoperabilität. Angenommen, Sie haben eine Bibliothek oder API oder ein Subsystem, dem Konfigurations- oder Datendateien zugeordnet sind. Auf dieses Subsystem soll aus verschiedenen Sprachen zugegriffen werden. Dann erzählst du es den Leuten: Vergiss übrigens nicht, die Kommentare aus den JSON-Dateien zu entfernen, bevor du sie an den Parser weitergibst!

Wenn Sie JSON5 verwenden , können Sie Kommentare einfügen .

JSON5 ist eine vorgeschlagene Erweiterung von JSON , die es dem Menschen erleichtern soll, von Hand zu schreiben und zu warten. Dazu werden einige minimale Syntaxfunktionen direkt aus ECMAScript 5 hinzugefügt.

Mit dem Dojo Toolkit JavaScript Toolkit (mindestens ab Version 1.4) können Sie Kommentare in Ihren JSON aufnehmen. Die Kommentare können /* */formatiert sein. Das Dojo Toolkit verwendet den JSON über den dojo.xhrGet()Aufruf.

Andere JavaScript-Toolkits funktionieren möglicherweise ähnlich.

Dies kann hilfreich sein, wenn Sie mit alternativen Datenstrukturen (oder sogar Datenlisten) experimentieren, bevor Sie eine endgültige Option auswählen.

JSON ist kein gerahmtes Protokoll . Es ist ein sprachfreies Format . Das Format eines Kommentars ist daher für JSON nicht definiert.

Wie viele Leute vorgeschlagen haben, gibt es einige Tricks, zum Beispiel doppelte Schlüssel oder einen bestimmten Schlüssel _comment, den Sie verwenden können. Es liegt an dir.

Sie können Kommentare in JSONP haben , aber nicht in reinem JSON. Ich habe gerade eine Stunde damit verbracht, mein Programm mit diesem Beispiel aus Highcharts zum Laufen zu bringen: http://www.highcharts.com/samples/data/jsonp.php?filename=aapl-c.json&callback=?

Wenn Sie dem Link folgen, werden Sie sehen

?(/* AAPL historical OHLC data from the Google Finance API */
[
/* May 2006 */
[1147651200000,67.79],
[1147737600000,64.98],
...
[1368057600000,456.77],
[1368144000000,452.97]
]);

Da ich eine ähnliche Datei in meinem lokalen Ordner hatte, gab es keine Probleme mit der Richtlinie für denselben Ursprung. Daher habe ich mich für die Verwendung von reinem JSON entschieden ... und bin natürlich $.getJSONaufgrund der Kommentare unbemerkt gescheitert.

Schließlich habe ich gerade eine manuelle HTTP-Anfrage an die oben angegebene Adresse gesendet und festgestellt, dass der Inhaltstyp war, text/javascriptda JSONP reines JavaScript zurückgibt. In diesem Fall sind Kommentare zulässig . Da meine Anwendung jedoch den Inhaltstyp zurückgab application/json, musste ich die Kommentare entfernen.

Dies ist eine "Kannst du" -Frage. Und hier ist eine "Ja" Antwort.

Nein, Sie sollten keine doppelten Objektelemente verwenden, um Seitenkanaldaten in eine JSON-Codierung einzufügen. (Siehe "Die Namen innerhalb eines Objekts sollten eindeutig sein" im RFC ).

Und ja, Sie könnten Kommentare um den JSON einfügen , die Sie analysieren könnten.

Wenn Sie jedoch beliebige Seitenkanaldaten in einen gültigen JSON einfügen und extrahieren möchten, finden Sie hier eine Antwort. Wir nutzen die nicht eindeutige Darstellung von Daten in einer JSON-Codierung. Dies ist ^* in Abschnitt 2 des RFC unter "Leerzeichen sind vor oder nach einem der sechs Strukturzeichen zulässig" zulässig.

^* Der RFC gibt nur an, dass "Leerzeichen vor oder nach einem der sechs Strukturzeichen zulässig sind", wobei Zeichenfolgen, Zahlen, "false", "true" und "null" nicht explizit erwähnt werden. Diese Auslassung wird in ALLEN Implementierungen ignoriert.

Kanonisieren Sie zunächst Ihren JSON, indem Sie ihn minimieren:

$jsonMin = json_encode(json_decode($json));

Codieren Sie dann Ihren Kommentar binär:

$hex = unpack('H*', $comment);
$commentBinary = base_convert($hex[1], 16, 2);

Dann steu deine Binärdatei:

$steg = str_replace('0', ' ', $commentBinary);
$steg = str_replace('1', "\t", $steg);

Hier ist Ihre Ausgabe:

$jsonWithComment = $steg . $jsonMin;

HAFTUNGSAUSSCHLUSS: DAS IST DUMM

Es gibt tatsächlich eine Möglichkeit, Kommentare hinzuzufügen und innerhalb der Spezifikation zu bleiben (kein zusätzlicher Parser erforderlich). Es wird jedoch nicht zu lesbaren Kommentaren führen, ohne dass eine Analyse durchgeführt wird.

Sie könnten Folgendes missbrauchen:

Vor oder nach einem Token ist ein unbedeutendes Leerzeichen zulässig. Leerzeichen sind beliebige Folgen eines oder mehrerer der folgenden Codepunkte: Zeichentabelle (U + 0009), Zeilenvorschub (U + 000A), Wagenrücklauf (U + 000D) und Leerzeichen (U + 0020).

Auf hackige Weise können Sie dies missbrauchen, um einen Kommentar hinzuzufügen. Zum Beispiel: Beginnen und beenden Sie Ihren Kommentar mit einem Tabulator. Codieren Sie den Kommentar in base3 und verwenden Sie die anderen Leerzeichen, um sie darzustellen. Zum Beispiel.

010212 010202 011000 011000 011010 001012 010122 010121 011021 010202 001012 011022 010212 011020 010202 010202

( hello base threein ASCII) Verwenden Sie jedoch anstelle von 0 Leerzeichen, für 1 Zeilenvorschub und für 2 Wagenrücklauf.

Dadurch bleiben Ihnen nur viele unlesbare Leerzeichen (es sei denn, Sie erstellen ein IDE-Plugin, um es im laufenden Betrieb zu codieren / decodieren).

Ich habe das aus offensichtlichen Gründen noch nie versucht und du auch nicht.

Wir verwenden strip-json-commentsfür unser Projekt. Es unterstützt so etwas wie:

/*
 * Description 
*/
{
    // rainbows
    "unicorn": /* ❤ */ "cake"
}

Einfach npm install --save strip-json-commentszu installieren und zu verwenden wie:

var strip_json_comments = require('strip-json-comments')
var json = '{/*rainbows*/"unicorn":"cake"}';
JSON.parse(strip_json_comments(json));
//=> {unicorn: 'cake'}

In meinem Fall muss ich Kommentare für Debug-Zwecke verwenden, bevor die JSON-Struktur ausgegeben wird. Deshalb habe ich mich entschlossen, Debug-Informationen im HTTP-Header zu verwenden, um eine Unterbrechung des Clients zu vermeiden:

header("My-Json-Comment: Yes, I know it's a workaround ;-) ");

JSON erlaubt per se keine Kommentare. Die Argumentation ist absolut dumm, da Sie JSON selbst verwenden können , um Kommentare zu erstellen, wodurch die Argumentation vollständig entfällt und der Parser-Datenraum ohne triftigen Grund für genau das gleiche Ergebnis und potenzielle Probleme geladen wird, wie z. B .: Ein JSON Datei mit Kommentaren.

Wenn Sie versuchen, Kommentare einzufügen (mit //oder /* */oder #zum Beispiel), schlagen einige Parser fehl, da dies streng genommen nicht in der JSON-Spezifikation liegt. Das solltest du also niemals tun.

Hier ist zum Beispiel ein Beispiel, in dem mein Bildmanipulationssystem Bildnotationen und einige grundlegende formatierte (Kommentar-) Informationen dazu gespeichert hat (unten):

{
    "Notations": [
        {
            "anchorX": 333,
            "anchorY": 265,
            "areaMode": "Ellipse",
            "extentX": 356,
            "extentY": 294,
            "opacity": 0.5,
            "text": "Elliptical area on top",
            "textX": 333,
            "textY": 265,
            "title": "Notation 1"
        },
        {
            "anchorX": 87,
            "anchorY": 385,
            "areaMode": "Rectangle",
            "extentX": 109,
            "extentY": 412,
            "opacity": 0.5,
            "text": "Rect area\non bottom",
            "textX": 98,
            "textY": 385,
            "title": "Notation 2"
        },
        {
            "anchorX": 69,
            "anchorY": 104,
            "areaMode": "Polygon",
            "extentX": 102,
            "extentY": 136,
            "opacity": 0.5,
            "pointList": [
                {
                    "i": 0,
                    "x": 83,
                    "y": 104
                },
                {
                    "i": 1,
                    "x": 69,
                    "y": 136
                },
                {
                    "i": 2,
                    "x": 102,
                    "y": 132
                },
                {
                    "i": 3,
                    "x": 83,
                    "y": 104
                }
            ],
            "text": "Simple polygon",
            "textX": 85,
            "textY": 104,
            "title": "Notation 3"
        }
    ],
    "imageXW": 512,
    "imageYW": 512,
    "imageName": "lena_std.ato",
    "tinyDocs": {
        "c01": "JSON image notation data:",
        "c02": "-------------------------",
        "c03": "",
        "c04": "This data contains image notations and related area",
        "c05": "selection information that provides a means for an",
        "c06": "image gallery to display notations with elliptical,",
        "c07": "rectangular, polygonal or freehand area indications",
        "c08": "over an image displayed to a gallery visitor.",
        "c09": "",
        "c10": "X and Y positions are all in image space. The image",
        "c11": "resolution is given as imageXW and imageYW, which",
        "c12": "you use to scale the notation areas to their proper",
        "c13": "locations and sizes for your display of the image,",
        "c14": "regardless of scale.",
        "c15": "",
        "c16": "For Ellipses, anchor is the  center of the ellipse,",
        "c17": "and the extents are the X and Y radii respectively.",
        "c18": "",
        "c19": "For Rectangles, the anchor is the top left and the",
        "c20": "extents are the bottom right.",
        "c21": "",
        "c22": "For Freehand and Polygon area modes, the pointList",
        "c23": "contains a series of numbered XY points. If the area",
        "c24": "is closed, the last point will be the same as the",
        "c25": "first, so all you have to be concerned with is drawing",
        "c26": "lines between the points in the list. Anchor and extent",
        "c27": "are set to the top left and bottom right of the indicated",
        "c28": "region, and can be used as a simplistic rectangular",
        "c29": "detect for the mouse hover position over these types",
        "c30": "of areas.",
        "c31": "",
        "c32": "The textx and texty positions provide basic positioning",
        "c33": "information to help you locate the text information",
        "c34": "in a reasonable location associated with the area",
        "c35": "indication.",
        "c36": "",
        "c37": "Opacity is a value between 0 and 1, where .5 represents",
        "c38": "a 50% opaque backdrop and 1.0 represents a fully opaque",
        "c39": "backdrop. Recommendation is that regions be drawn",
        "c40": "only if the user hovers the pointer over the image,",
        "c41": "and that the text associated with the regions be drawn",
        "c42": "only if the user hovers the pointer over the indicated",
        "c43": "region."
    }
}

Um ein JSON-Element in Teile zu schneiden, füge ich "Dummy-Kommentar" -Zeilen hinzu:

{

"#############################" : "Part1",

"data1"             : "value1",
"data2"             : "value2",

"#############################" : "Part2",

"data4"             : "value3",
"data3"             : "value4"

}