4 ms·
If you're curious to read a well-earned take on comments: http://antirez.com/news/124 http://antirez.com/news/124. Inline comments are a reflection on the auth
by gen220 3y ago
If you're curious to read a well-earned take on comments: http://antirez.com/news/124 http://antirez.com/news/124.
Inline comments are a reflection on the authors' abilities to write good comments. They can be kinda useless, actually-bad, or really helpful.
One canonical example of a "good comment" is explaining why a strange or not-the-least-complex approach was taken to implementing a certain solution. The code is like chesterton's fence, and the comment is a post explaining why it's there. That way, future readers can better assess for themselves whether it's worth their time trying to tear down the fence.