Használhatok megjegyzéseket egy JSON fájlban? Ha igen, hogyan?
Nem.
A JSON-nak mind adatnak kell lennie, és ha megjegyzést ad hozzá, akkor az is adat lesz.
Lehetne egy kijelölt adatelem, amelynek neve "_comment"
(vagy valami hasonló), amelyet a JSON-adatokat használó alkalmazások figyelmen kívül hagynának.
Valószínűleg jobb lenne, ha a megjegyzést a JSON-t generáló/fogadó folyamatokban lenne, mivel nekik előre tudniuk kellene, hogy mi lesz a JSON-adat, vagy legalábbis a szerkezetét.
De ha úgy döntöttél, hogy:
{
"_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"
}
}
}
}
}
Nem lehet. Legalábbis ez a tapasztalatom a json.org gyors áttekintése alapján.
A JSON szintaxisa azon az oldalon láthatóvá van téve. A megjegyzésekről nincs'semmiféle megjegyzés.
A JSON lényege az alkalmazások közötti egyszerű adatcsere biztosítása. Ezek jellemzően webes alapúak, és a nyelvük a JavaScript.
Ez nem igazán teszi lehetővé a megjegyzések használatát, azonban a megjegyzés átadása az adatokban szereplő név/érték párok egyikeként biztosan működne, bár ezt az adatot nyilvánvalóan figyelmen kívül kell hagyni, vagy az elemző kódnak külön kell kezelnie.
Mindezek mellett nem áll szándékunkban, hogy a JSON fájl a hagyományos értelemben vett megjegyzéseket tartalmazzon. Csak az adatoknak kell lennie.
További részletekért nézze meg a JSON weboldalon.