In a group project at Uni, one of the coders did comment his code. Mind you, with his choice of language, we'd really rather he hadn't. Further more, the on-screen display was titled "Information Kiosk Bulls***". He does realise we're getting marked on this, doesn't he?
Haaaaaaaaahahahah....he he he hilarious. <img src="/ubbthreads/images/graemlins/delight.gif" alt="" /> <img src="/ubbthreads/images/graemlins/delight.gif" alt="" />
Still LOL.
No, no I must control myself and stop laughing, really.
Ok.
It all begins with discipline and ends with discipline.
A coder should never comment his code for himself but for others, because that is the original reason for commenting, maintenance.
A code may be abandoned for many months before revisited and then re-comprehending it would depend greatly on verbosity, good spelling and a perfect choice of names representing input process and output data.
An integer counter may be called “i” but what is so wrong about calling it i_Finished_Pencil_Counter?
Why should lpL_Molten_Core_Temperature be called T1?
The better we choose the names, the less the needed comment, because such names are self explanatory.
In conditional loop-sections we need to comment the purpose of the loop and its conditional exiting information.
Comments should be as short and specific as possible to avoid confusion.
Of course “Nocando” titles are a big no no. <img src="/ubbthreads/images/graemlins/biggrin.gif" alt="" />
It only reflects the mentality of the programmer and in that case, I assure you that he was completely a misplaced person who belongs to a brothel. <img src="/ubbthreads/images/graemlins/evilgrin1.gif" alt="" />