>>
>>Oh, I forgot one more rule. It's number 11 (I think)
>>
>>11. Don't comment the obvious.
>
> That's one I break almost daily ;-) I tend to put an "English translation" of each chunk of my code above the section. It saves me so much trouble when I have to go back later(ie. I don't have to think like a computer to find what I'm looking for). What's obvious to me while I'm coding can be a complete mystery to me a few days later. I error on the side of caution.
Hi Paul,
I was referring to a situation where if what's being would be blatantly obvious to by looking a no more than two lines.
Generally, the bulk of my comments are written before any code is written. There's at least one line describing the module (and I try to limit it at that), then I write down the steps that are needed to accomplish whatever task the module is charged with. Oftimes, these comments indicate where another module needs to be called. Naturally, if I've been too vague with steps, additional comments are added.
George
Ubi caritas et amor, deus ibi est