Tells you nothing new - a wasted comment. Everyone who can program know this. A comment that describes what you do.
i++; // increase i to move to the next entry
A better comment, explaining why you do what you do. Always add information in your comments that the code doesn't supply already. If you name your variables and methods well, good code is often self-explanatory. Use comments when it's not.
Of course in this trivial example no comment would be needed.
I've found github pages with seemingly a lot of documentation, commented code etc. But nothing about what the app or whatever is actually for. You gotta sit there and read through it all and kinda make a guess on what it is.
9 replies
When you are reading a math textbook and it says the proof for this theorem is trivial.
this is left as an exercise for the reader
My code is self-explanatory
Yes, I don't see the problem? I don't think I am doing anything wrong?
Yes I had a coworker that commented like that:
Tells you nothing new - a wasted comment. Everyone who can program know this. A comment that describes what you do.
A better comment, explaining why you do what you do. Always add information in your comments that the code doesn't supply already. If you name your variables and methods well, good code is often self-explanatory. Use comments when it's not.
Of course in this trivial example no comment would be needed.
Oh and use XML comments, when applicable.
I love that this is a photo of a print that has been places. Analog meme.
I've found github pages with seemingly a lot of documentation, commented code etc. But nothing about what the app or whatever is actually for. You gotta sit there and read through it all and kinda make a guess on what it is.