This is for example indicated for configuration files stored in JSON, as user23987's comment below. Obviously, since JSON is primarily meant as a data transmission format, and hence as sparse as possible, if you transmit a JSON file with comments, it's better to strip out comments before to save network bandwidth. Source: JSON does not have ...

As you can see from the link posted by Vicky, you cannot have comments in JSON files as it will be interpreted as data. There are some workarounds if you really, really need them, like defining a data element which is dummy, igonred and used only for commenting purposes –

Jun 22, 2022 · If the JSON file won't be modified by apps, you can simply make up a property the app doesn't use and store the comment in it. This takes up a little space at runtime but it works. I do this all the time for temporary comments like TO-DOs. You can also display such comments at runtime because they're part of the data. –

Aug 31, 2017 · JSON specification doesn't include comments of any kind. You can simply add a standard key/value pair with a key that gets ignored by the application (maybe _comment ) but there is no way to insert a proper comment.

@JamesNewtonKing I've written a small patch to the latest Json.NET to add a Comment property to JsonProperty (and JsonPropertyAttribute). The idea is that during SerializeMemberInfo if the Comment is not null/empty then it gets written out above the key/value pair in the JSON.

Apr 30, 2015 · Because json spec defines no comment at all, and that is by design, so no json library would output a json file with comment. Those comments are usually added later, by a human. No exception in this case. The OP mentioned that in his post: //"birthday": "nothing" //I comment this line.

Oct 20, 2015 · Configuration files often need comments for maintainability, and for debugging (E.G. Comment out original lines while modifying the config to make it easy to go back to the original if the changes don't work well.).json doesn't support comments, except through hacks. There are numerous hacks to add comment support into JSON, many are mentioned ...

Sep 2, 2021 · It wouldn't work if you are using other comment styles such as # or if the real data in your json file contains a // character such as ["appl//es"],. I updated the answer to use a library. I updated the answer to use a library.

Dec 22, 2019 · JSON containing comments can be parsed by System.Text.Json, but by default such JSON is considered invalid, likely since comments are not included in the JSON standard. Support for comments nevertheless can be enabled by modifying the JsonCommentHandling enum in options: Disallow 0 Doesn't allow comments within the JSON input.

Sep 24, 2020 · Found this useful, but I also agree with v-andrew - usually want to keep the jsonc separate from the normal json files. Where I found this useful though is vendor supplied files - like rush.json which the vendor supplies with comments. In that case use a file association like: "files.associations": { "rush.json": "jsonc" } no need to wildcard it.