Môžem v súbore JSON používať komentáre? Ak áno, ako?
Nie.
JSON by mal byť dátový, a ak uvediete komentár, bude tiež dátový.
Mohli by ste mať určený dátový prvok s názvom "_comment"
(alebo niečo podobné), ktorý by aplikácie používajúce údaje JSON ignorovali.
Pravdepodobne by bolo lepšie, keby ste mali komentár v procesoch, ktoré generujú/prijímajú JSON, pretože tie by mali vopred vedieť, aké budú údaje JSON, alebo aspoň ich štruktúru.
Ak by ste sa však rozhodli:
{
"_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"
}
}
}
}
}
Hlavnou myšlienkou JSON je zabezpečiť jednoduchú výmenu údajov medzi aplikáciami. Tie sú zvyčajne založené na webe a ich jazykom je JavaScript.
V skutočnosti neumožňuje komentáre ako také, avšak odovzdanie komentára ako jedného z párov meno/hodnota v údajoch by určite fungovalo, hoci tieto údaje by sa zrejme museli ignorovať alebo by sa s nimi muselo osobitne zaobchádzať v analyzujúcom kóde.
To všetko znamená, že nie je zámerom, aby súbor JSON obsahoval komentáre v tradičnom zmysle. Mali by to byť len údaje.
Podrobnejšie informácie nájdete na webovej stránke JSON.