Hacker News new | past | comments | ask | show | jobs | submit login

When maintaining a JSON file, did you ever happen to wonder why a particular value is what it is?

This is where comments belong.




If it's that important and complex, have an accompanying README that lists line numbers and comments.


Good idea! And then put a comment into the configuration file that refers to where the documentation is.. ah, f__k!


Lesson to learn: Nobody reads the docs.


This is such a dumb aphorism. I read and create docs every single day.

If the comments are so critical that it is a problem, then an accompanying file with those comments would be used. Otherwise, it's just a bunch of crocodile tears.




Consider applying for YC's Spring batch! Applications are open till Feb 11.

Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: