20 Oct
2005
20 Oct
'05
3:10 a.m.
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, I made it very
clear that comments shuold describe the algorithm, not just each line of
code. So, for example, instead of "Push R2 onto the stack" it would say
"squirrel R2 away because it's gonna get clobbered in a minute and we'll
need it again", followed later by "retrieve the value we saved earlier,
so that now we can ...".
--
David Cantrell | Reality Engineer, Ministry of Information
Gehyrst ?u, s?lida, hw?t ?is folc sege??
Hi willa? eow to gafole garas syllan,
?ttrynne ord and ealde swurd,
?a heregeatu ?e eow ?t hilde ne deah.
-- Byrhtno?