Skip to content

stephenberry/JSONC

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 

Repository files navigation

JSONC

JSON with Comments. This is a simple reference specification for JSONC.

JSONC makes JSON documents more useful for humans and avoids embedding comments as part of the JSON document, which hurts performance and clarity.

JSONC allows C and Javascript style comments. When a JSONC document is read, all comments must be ignored and the result is a JSON structure identical to a JSONC document with all the comments stripped.

.jsonc is the standard file extension for JSONC

Line Comments

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

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 */

About

JSON with comments specification.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published