code comments

[NotAllThere]

Question.

Do you write comprehensive code comments, thus making the job much longer (kerrching) but making it much easier for someone else to pickup the code and replace you, or write cryptic comment free code that is quick to write (no contract renewal) but no bugger can pick it up (and get called back in on a new contract)?

I write comprehensive code comments that add value, thus making the job slightly longer (kerc) but making it much easier for someone else to pickup the code and replace me, while I get on with something more lucrative and interesting.

[NotAllThere]

The last thing testers need is bug-free software.

That's why you love programmers so much, and sabotage the good ones!

[Mich the Tester]

I write comprehensive code comments that add value, thus making the job slightly longer (kerc) but making it much easier for someone else to pickup the code and replace me, while I get on with something more lucrative and interesting.

like posting on CUK?

[Mich the Tester]

That's why you love programmers so much, and sabotage the good ones!

We're all interdependent. You make the bugs, I find them. If you don't make bugs, I expose the crap programmers and make your life easier. We all get rich. BOOMED!

[Gros]

At a previous client a spend three days investigating why one of their services had stopped working. I tracked it down to an SQL call embedded in the following try/catch code:

try{
        ...lots of real code here
}catch(Exception e){
        // ignore, probably nothing
}

That comment certainly helped me

[NickFitz]

If you're writing a class that long you need to be shot.

Assembler isn't object orientated... no such thing as a class

[Spacecadet]

Assembler isn't object orientated... no such thing as a class

so many deaths that could have been prevented

[Sysman]

Anyone read showstopper by steve cutler?

I thought the arguments they had over code commentating were interesting.

Essentially no-one commented their code except Steve Cutler. Their argument being comments get out of date. He updated his comments as he went along.....

Dave Cutler.

Show Stopper!: The Breakneck Race to Create Windows NT and the Next Generation at Microsoft

I am told that he was, ahem, difficult to work with.

[Sysman]

Someone I know cut and paste some code from the internet (including comments) and put it in production code. The comments were in Spanish, but he thought he better leave them in.

During testing it was found that the code didn't work. After putting the Spanish comments through google translator it came out as "This code is an example, and I can't get it to work, not sure why"

Post of the month!

[FSM with Cheddar]

Post of the month!

Thanks