43
What is the best file format for configuration file?
(programming.dev)
A community for discussion amongst professional software developers.
Posts should be relevant to those well into their careers.
For those looking to break into the industry, are hustling for their first job, or have just started their career and are looking for advice, check out:
A lot of good answers but I would add one note:
You disgust me
This is actually pretty genius, why haven't ever thought of that?
I liked the idea to be honest. I can just call the entry "description" instead and all is good ^^
How do you comment multiple properties separately?
Don't worry, I wouldn't do things like this in JSON. Nevertheless, it can be very useful to have comments along with configuration values, for example to explain the actual values (not their purpose) and why they were chosen. That's information you can't add to the code which processes the values.
I believe the JSON deserializer .NET ships with has options to allow C#-style comments in JSON files.
JSON5 is a superset of JSON that supports comments.
json with comments can be parsed by a yaml parser. It's how I write yaml, in fact (yaml is a superset of json. any valid json is valid yaml, but it also supports comments)