David Cantrell wrote:
On Fri, Oct 14, 2005 at 09:40:52PM -0700, Chuck Guzis
wrote:
I start grinding my teeth when I read stuff like
this:
PSHR R2 ; Push R2 onto the stack
MVII 10,R1 ; Move 10 to R1
A comment on every line that describes exactly what's happening without any
sort "big picture". Absolutely meaningless.
Grargh! When I wrote our coding guidelines at work,
Ahh, I remember writing coding standards too...
of course real comments are just numerical indexes into a comments
database, so that your company can be international and supply code
comments in many different languages... :-)
That was such a scary thought I had to share it, although I suppose it
does point out that comments are only useful if you speak the language
they're written in, and there's no real substitute for decent code which
goes a long way toward explaining itself... :-)
cheers
Jules