I was hoping that someone would bring up the VTML topic. It would be
so cool, if you pressed a shortcut and documentation editor would
pop up. You could choose a comment/variable/whatever type from dropdown
menu add your text and click OK. Since Studio's Visual Tools Object
Model is scriptable, it could automatically add your new comment to
the top of your template, where all the other comments are, and you
could
continue coding from the same point where you left off. It would
be some much easier that way, because we wouldn't have to jump to the
beginning of the file and write that comment for one new variable you
used and then go back to where you were.
What do you think?
Erki
----- Original Message -----
From: "BOROVOY Noam" <[EMAIL PROTECTED]>
To: <[EMAIL PROTECTED]>
Sent: Tuesday, August 29, 2000 5:16 PM
Subject: RE: FuseDoc specification
> Hey the object notation is pretty cool!
> I might just use it (if I did ever document my code that is ;-)
> In the past I'vestarted using fusedoc and found that code evolution
just
> left most of the doc outdated, now if there was a nice interface to
edit the
> documentation which would generate the notation for me and I would
only have
> to fill in the text boxes - like a VTML wizard or a small CF app then
I
> might just try and document again...
>
>
> ----------
> From: John Foulds [SMTP:[EMAIL PROTECTED]]
> Sent: Tuesday, 29 August 2000 16:56
> To: [EMAIL PROTECTED]
> Subject: Re: FuseDoc specification
>
>
> Drat. Thought I was in Studio and not Outlook. Hit Alt-S for a
> global
> search and replace and sent the message too soon. I hate it when
> that
> happens.
>
> Oh vey. Was going to change the start-of-line delimeter to "||" for
> readability.
>
> Qualifier: I know this veers away from the symbol notation that
> people have
> already used in-place for a number of apps. It is just
> train-of-thought.
> Once I spent more time on thinking about how to scribe it better, I
> was
> planning on trying to write a tag that converted FuseDoc syntax into
> object.property syntax. I may still try, but the FuseDoc syntaxes
> people
> have been using that I have seen all seem slightly different, so it
> may not
> be possible.
>
> I will probably get beat up, and people will nonetheless barf on it,
> but it
> is pretty readable, extensible and parsable.
>
> <!---FUSEDOC
> || fusedoc.description = This is a nice little template
> || fusedoc.warning = This template won't work on Solaris
> || fusedoc.designer.name = Sam I. Am
> || fusedoc.designer.email = [EMAIL PROTECTED]
> || fusedoc.programmer.name = Bob Robertson || ex-employee
> || fusedoc.programmer.email = [EMAIL PROTECTED]
> || variable.session.in.required = userid numeric
> || variable.session.in.optional = userid numeric
> || variable.attributes.in.required = userid numeric
> || variable.attributes.in.optional = userid numeric
> || variable.cookie.passthru.required = status string
> || variable.form.out.required = userid numeric
> || variable.form.out.optional = userid numeric || only on
> Wednesdays
> || variable.form.passthru.required = userid numeric
> || variable.application.passthru.required = userid numeric
> || query.cached.passthru.required = queryname
> || query.uncached.in.optional = queryname
> || query.uncached.out.required = queryname
> || query.cached.passthru.optional = queryname
> || file.include.required = file.cfm local
> || file.include.optional = file.cfm ../scripts
> END FUSEDOC--->
>
> John Foulds
> Ottawa, Canada
>
------------------------------------------------------------------------------
To Unsubscribe visit
http://www.houseoffusion.com/index.cfm?sidebar=lists&body=lists/fusebox or send a
message to [EMAIL PROTECTED] with 'unsubscribe' in the body.
