I needed to look at if from another angle. I reckon you are right.
----- Original Message -----
From: "Lee Borkman" <[EMAIL PROTECTED]>
To: <[EMAIL PROTECTED]>
Sent: Friday, May 10, 2002 7:48 PM
Subject: Re: Is anyone fusedocing fusedocs?
Hi John.
Fusedocs have several purposes. Only one of these is to "document" the
code. Purposes include:
a.. specifying the code in the first place
b.. verifying the code against the spec
c.. seperating the roles of expert architect and expert coder
d.. automated documentation
e.. portability / language-independence
f.. consistency / predictability
g.. clarity
h.. automated generation
i.. automated testing
Whatcha reckon?
LeeBB
----- Original Message -----
From: John Jonathan Kopanas
If comments are 1:1 isn't it better to just read the code? Especially CF
that is so easy to read. I understand documenting what is not obvious in
the code, but sometimes it gets to far.
----- Original Message -----
From: "Lee Borkman" <[EMAIL PROTECTED]>
I don't know. It's not uncommon to have 20 lines of Fusedoc and one line
of
code. I'd worry if many or most of your fuses were like that, but it's
perfectly reasonable now and then. In general, I'd expect an average
ratio
of 1:1, but that's just a guess.
LeeBB
----- Original Message -----
From: John Jonathan Kopanas
I hope you are being sarcastic. Otherwise there is something wrong with
your code.
> Is anyone fusedocing fusedocs? Im not sure that I
> will be satisfied with my applications unless my
> comments exceed my code by a ratio of at least 3:1.
==^================================================================
This email was sent to: [email protected]
EASY UNSUBSCRIBE click here: http://topica.com/u/?bUrFMa.bV0Kx9
Or send an email to: [EMAIL PROTECTED]
T O P I C A -- Register now to manage your mail!
http://www.topica.com/partner/tag02/register
==^================================================================
