undefined | Better HN

0 pointsthrowaway357846y ago0 comments

  //increment i in for loop
  For (i=0;i++....

  Var x; //define variable x

  X=4; //give value of 4 to x

Everyone knows what that code does. The comments aren't necessary.

0 comments

tchaffee6y ago

That's a good concrete example of bad comments. I suppose you could throw that in the "over-commenting" category.

throwaway35784OP6y ago

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.

lostgame6y ago

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.

throwaway35784OP6y ago

Yes it's an example of over commenting, which is exactly what the gp wanted.

_y5hn6y ago

This is instructive to new coders, on how NOT to comment.

throwaway35784OP6y ago

That's what was asked for! Why on earth is the comment that properly delivers the expectation being discussed as though it's wrong?

_y5hn6y ago

I noticed the downvote and upvoted, plus acknowledged the anti-pattern. Sometimes intent is lost in text.

j / k navigate · click thread line to collapse

0 pointsthrowaway357846y ago0 comments

  //increment i in for loop
  For (i=0;i++....

  Var x; //define variable x

  X=4; //give value of 4 to x

Everyone knows what that code does. The comments aren't necessary.

0 comments

tchaffee6y ago

That's a good concrete example of bad comments. I suppose you could throw that in the "over-commenting" category.

throwaway35784OP6y ago

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.

lostgame6y ago

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.

throwaway35784OP6y ago

Yes it's an example of over commenting, which is exactly what the gp wanted.

_y5hn6y ago

This is instructive to new coders, on how NOT to comment.

throwaway35784OP6y ago

That's what was asked for! Why on earth is the comment that properly delivers the expectation being discussed as though it's wrong?

_y5hn6y ago

I noticed the downvote and upvoted, plus acknowledged the anti-pattern. Sometimes intent is lost in text.

j / k navigate · click thread line to collapse