Re:Keep your source code SIMPLE
by throwaway35784 on Sunday November 10, 2019 @12:01PM
(#21498830)
Everyone knows what that code does. The comments aren't necessary.
[ Parent
| on HN ]
That's a good concrete example of bad comments. I suppose you could throw that in the "over-commenting" category.
Re:Keep your source code SIMPLE
by throwaway35784 on Sunday November 10, 2019 @05:05PM
(#21500459)
And, strangely, it's the only response to the gp's request to define of over-commenting, yet it is downvoted to below definitions of good commenting.
So. Weird. The other responses didn't properly implement the requirement specification.
I am so confused.
This is what I’m saying by over-commenting. I stated comments at the beginning of functions - what are the arguments? - what does it return - or at the beginning of class names are the wise go.
Re:Keep your source code SIMPLE
by throwaway35784 on Sunday November 10, 2019 @05:07PM
(#21500471)
Yes it's an example of over commenting, which is exactly what the gp wanted.
This is instructive to new coders, on how NOT to comment.
Re:Keep your source code SIMPLE
by throwaway35784 on Sunday November 10, 2019 @05:09PM
(#21500479)
That's what was asked for! Why on earth is the comment that properly delivers the expectation being discussed as though it's wrong?