this post was submitted on 15 Aug 2023
43 points (100.0% liked)
Experienced Devs
3956 readers
1 users here now
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:
- Logo base by Delapouite under CC BY 3.0 with modifications to add a gradient
founded 1 year ago
MODERATORS
you are viewing a single comment's thread
view the rest of the comments
view the rest of the comments
Of course it does!
You disgust me
This is actually pretty genius, why haven't ever thought of that?
It's so easy to use, and you can read the comments from in your program too!
^(in case you weren't just playing along, please never do comments this way)
I liked the idea to be honest. I can just call the entry "description" instead and all is good ^^
Ideally, you would use TOML for human-readable configuration and document your JSON API with external documentation instead of sending comments around a bunch. If you need to display the description to the end user though, that would be a valid use case.
How do you comment multiple properties separately?
Please don't actually do this. Comment stuff in the code and documentation, not the JSON.
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.