> No, we should read his post and from that we find that this person
> has received the painful instructions to fusedoc some existing code.
> Furthermore, he is after a tool to help him achieve this without
> opening each file and typing them in, one at a time.
<cf_bitchmode value="on">
His post didn't read that at all. All he said was that he needed to document
and was considering Fusedoc--the original post did not say that he's been
instructed to fusedoc something, just that he's been instructed to document
somehow
</cf_bitchmode value="off">
was the only question "is there a auto-tool?" ?? If so, the answer is no. So
much for that.
Was the question also "what do you guys think I should do if there isn't a
tool?"?? If so, then if he's already got documentation in one format, I say
stick with it that method, get the job done, add in Fusedocs in the next
iteration or project when you can take a deep breath. If you don't have any
docs at all then you might as well jump right in--I would leave out the
fusedocing of query result sets etc, just stick to incoming, outgoing,
globals, and included files, that will make things quicker. Remember that
you can totally forget about any local variables since they are not
fusedoced. Basically any variable in your template that has a scope should
go into the fusedoc...Also, you don't really have to have a full description
of each of those, esp for the globally known vars--just get them into the
fusedoc as
<-- form.ProjectID :
rather than
<-- form.ProjectID : this is the PKID of the Projects table
I'd save that complete info for a time when you write the fusedoc ahead of
time and by then you'll be more comfortable with Fusedocing anyway. I *do*
think it is important that you write a coherent Responsibilities section in
the first person--a good one of those is worth a lot more than a variable
list.
There are a number of fusedoc templates as well as a VTM add-in that will
let you quickly throw a Fusedoc into an already existing template, but it
will not fusedoc the code for you--it just wraps the fusedoc skeleton in
that single template opened in Studio. Oops! that wasn't the original
question so i guess I shouldn't have answered that point :)
----- Original Message -----
From: "Erik Voldengen" <[EMAIL PROTECTED]>
To: "Fusebox" <[EMAIL PROTECTED]>
Sent: Friday, April 13, 2001 1:57 PM
Subject: RE: FuseDoc's and WireFrame
>
> > should we imply from this that you are already coding even
> > though the specs
> > are not complete? If so, *that* is the (on-going) problem,
> > rather than the
> > time it would take to write fusedocs post-coding.
> >
>
>
>
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Structure your ColdFusion code with Fusebox. Get the official book at
http://www.fusionauthority.com/bkinfo.cfm
Archives: http://www.mail-archive.com/[email protected]/
Unsubscribe: http://www.houseoffusion.com/index.cfm?sidebar=lists
