Re:A developer goes to a DevOps conference
by probably_wrong on Saturday September 28, 2019 @04:27PM
(#21102664)
Comments was the reason for me to move from JSON to YAML in config files. I remember perfectly fine what every option does, but adding comments to each option is a must when it comes to sharing my code with anyone else.
[ Parent
| on HN ]
Re:A developer goes to a DevOps conference
by FlorianRappl on Monday September 30, 2019 @03:23PM
(#21118796)
If its a config file I'm not sure why you'll need comments. Comments / documentation should be in the system you'll do the config for. If your set options are that quirky / need documentation; why not explain them in a README?
But maybe I misunderstood. Can you give an example of a comment that makes sense / is required in a configuration JSON?
Re:A developer goes to a DevOps conference
by probably_wrong on Tuesday October 01, 2019 @08:09AM
(#21124395)
> If your set options are that quirky / need documentation; why not explain them in a README?
Mostly because I don't know whether the person customizing my code will read the README, but they'll definitely see the comments I wrote right before the configuration option itself.
With comments and some extra whitespace, they can go through the file line by line, read what a specific option does, configure it properly, and move on to the next one. No back and forth to the README required.