3 ms·
When maintaining a JSON file, did you ever happen to wonder why a particular value is what it is? This is where comments belong.
by nine_k 7y ago
When maintaining a JSON file, did you ever happen to wonder why a particular value is what it is?
This is where comments belong.
- CriticalCathed 7y agoIf it's that important and complex, have an accompanying README that lists line numbers and comments.
- meddlepal 7y agoLesson to learn: Nobody reads the docs.
- CriticalCathed 7y agoThis 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.
- js8 7y agoGood idea! And then put a comment into the configuration file that refers to where the documentation is.. ah, f__k!