Showing posts with label comments. Show all posts
Showing posts with label comments. Show all posts

Thursday, March 14, 2013

I see now why you choose not to comment your code.

Yes it looks like something I'd write, but it's not mine.  You'll just have to go ahead and fix that bug.
It is both a blessing and a curse when you find that your team writes code that is structured, both in organization and syntax, similarly.  On the one hand, you have consistency which if nothing else is pleasing from an architecture standpoint.  On the other you have consistency, which makes it easier for your teammates to claim ignorance of bugs and pawn the work off on you and simultaneously more difficult for one to deny authorship of said code.   At least we have source control for that....right?

Title: I see now why you choose not to comment your code.
Snarky: Yes it looks like something I'd write, but it's not mine.  You'll just have to go ahead and fix that bug.

Friday, July 20, 2012

If the quality of your code comments are any indication, 'sometimes' is an understatement.

Two in a Cube: Sometimes I think the only letter in team is I.
I can honestly say I have never put too much thought into "what makes a good comment". Maybe it's because their existence, usefulness, and general importance for code comprehension has always been obvious to me, or maybe because I'm rather terrible at using them consistently so would prefer not thinking about it.
Regardless of my reasons, I foundCoding Horror's thoughts on comments enlightening, particularly his very first point -- the best comments are the one's you don't need.


Title: If the quality of your code comments are any indication, 'sometimes' is an understatement.
Snarky: Sometimes I think the only letter in team is I.