xxxxxxxxxx
JSON does not support comments.
/* CSS/PHP/JS/SQL
Multiple Lines
\*
#Python
'''Python
Multiple Lines'''
xxxxxxxxxx
{
"_comment": "comment text goes here...",
"name": "your-app-name",
}
xxxxxxxxxx
No.
The JSON is data only, and if you include a comment, then it will be data too.
You could have a designated data element called "_comment" (or something) that should be ignored by apps that use the JSON data.
You would probably be better having the comment in the processes that generates/receives the JSON, as they are supposed to know what the JSON data will be in advance, or at least the structure of it.
But if you decided to:
{ "_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" } } } } }
xxxxxxxxxx
No.
The JSON is data only, and if you include a comment, then it will be data too.
You could have a designated data element called "_comment" (or something)
that should be ignored by apps that use the JSON data.
But if you decided to:
{
"_comment": "comment text goes here...",
"grocery": {
"title": "Some title",
}
}
xxxxxxxxxx
JSON does not support comments.
HOWEVER, some popular .json files like (tsconfig, eslint, ) allow comments
because the tools that use them deal with comments appropriatly.
xxxxxxxxxx
{
"//": "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"
}
xxxxxxxxxx
{
"_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"
}
}
}
}
}