This document explains JSON with Comments. It aims to be a simple reference specification for JSONC. JSONC is a format based on JSON but with some small features and more lenient parsing behaviors, which are specified below.
Why JSONC? JSONC makes JSON documents more useful for humans and avoids embedding comments as part of the JSON document, which hurts performance and clarity. The main feature of JSONC is that it allows C and Javascript style comments. When a JSONC document is read, when all comments are ignored it usually leads to a JSON structure identical to a JSONC document with all the comments stripped.
Note
.jsonc is the standard file extension for JSONC
Single line comments use double forward slashes // and the comment continues to the end of the line even if there are new comment symbols.
{ "x": 5 // this is a line comment
}Block comments support in place commenting and multi-line comments.
/*
Here is a block comment.
This can span multiple lines.
*/
{ "key": /*An in place comment*/ "a string" }JSONC restricts their usage to outside of strings (and therefore keys). Within strings they are considered part of the string.
{ "Key": "One upon /*This comment is part of the string*/ a time",
"Example": "Another example //of comment syntax as part of a string",
"A /*key with comment syntax*/": "The key contains the comment"
}Additionally much like c and c++ nested block comments are invalid.
/* /* This does not work */ The first comment close sequence closes the outer comment */