Können Kommentare in JSON verwendet werden?

Question

Kann ich Kommentare innerhalb einer JSON-Datei verwenden? Wenn ja, wie?

Answer 1

Seufz. Warum nicht einfach Felder hinzufügen, z. B.

{
    "note1" : "This demonstrates the provision of annotations within a JSON file",
    "field1" : 12,
    "field2" : "some text",

    "note2" : "Add more annotations as necessary"
}

Achten Sie nur darauf, dass Ihre "notex"-Namen nicht mit echten Feldern kollidieren.

Answer 2

Die reine Antwort lautet Nein .

Einige Editoren und Plattformen verwenden jedoch Umgehungslösungen, um Kommentare zu JSON hinzuzufügen.

1 . Heute haben die meisten Editoren integrierte Optionen und Erweiterungen, um Kommentare zu JSON-Dokumenten hinzuzufügen. (z.B.:- VS Code hat auch eine JSON mit Kommentaren (jsonc) mode / VS Code hat auch schöne Erweiterungen dafür)

Link zur Aktivierung des jsonc-Modus in VsCode

2 . Einige Plattformen bieten integrierte Möglichkeiten zum Hinzufügen von Kommentaren (impure json). (z.B.:- In Firebase kann ich kommentieren firebase.json s eine Zeit lang ohne Probleme.

    {
    "hosting": {
        "headers": [
            /*{
              "source": "*.html",
              "headers": [
                {
                  "key": "Content-Security-Policy",
                  "value": "default-src 'self' ..."
                }
              ]
            },*/
        ]
      }
    }

3 . In Ihrer eigenen JSON-Parsing-Methode können Sie einen vordefinierten Schlüsselnamen als Kommentar festlegen.

z.B.:-

     {
        "comment" : "This is a comment",
        "//" :  "This also comment",
        "name" : "This is a real value"
     }

Answer 3

Ich habe gerade " grunt-strip-json-comments ".

"Kommentare aus JSON entfernen. Damit können Sie Kommentare in Ihren JSON-Dateien verwenden!"

{
    // Rainbows
    "unicorn": /*  */ "cake"
}

Answer 4

Es gibt eine gute Lösung (Hack), die gültiges JSON ist, aber es wird nicht in allen Fällen funktionieren (siehe Kommentare unten). Machen Sie einfach denselben Schlüssel zweimal (oder öfter). Zum Beispiel:

{
  "param" : "This is the comment place",
  "param" : "This is value place",
}

JSON versteht dies also als:

{
  "param" : "This is value place",
}

Answer 5

Die praktische Antwort für Visual Studio-Code Nutzer im Jahr 2019 sollten die Erweiterung "jsonc" verwenden.

Es ist praktisch, weil dies die Erweiterung ist, die von Visual Studio Code erkannt wird, um "JSON mit Kommentaren" anzuzeigen. Bitte lassen Sie mich über andere Editoren/IDEs in den Kommentaren unten wissen.

Es wäre schön, wenn Visual Studio Code und andere Editoren auch native Unterstützung für JSON5 hinzufügen würden, aber im Moment bietet Visual Studio Code nur Unterstützung für "jsonc".

(Ich habe alle Antworten durchsucht, bevor ich dies geschrieben habe, und in keiner wird "jsonc" erwähnt).