3 ms·
This is the role of code comments for me: - Point It: Comment itself - Call It: Comment explicates why potentially surprising or ambiguous thing that follows
by klenwell 7y ago
This is the role of code comments for me:
- Point It: Comment itself
- Call It: Comment explicates why potentially surprising or ambiguous thing that follows is the way it is.
- Get It Right: Eliminates potential error in future. (Or maybe helps spot one if explanation doesn't mesh with observed behavior.)
I was just reviewing a PR requesting clarification of some config settings and this article (which I looked at earlier) came to mind.