> I like the fusedoc ideas of having symbols for in and out variables etc,
BUT
> (IMHO) these are not immediately understandable (sorry Hal) and so people
> are easily put off from using fusedoc.
I am IMHO with Paul on the symbol notation. It is documentation, and not
code.
1>must not have spaces or any arbitrary structure that can be played with
2>changing Hal's syntax in some way to make it word and not symbol based.
3>very important to be able to pick up the syntax VERY quickly and easily.
I have been experimenting with an ASP/JSP syntax using an object.property
notation, ie:
object.type.direction.property = name type || comment
I have included an example of both types of syntax below.
<!---FUSEDOC
Description = This is a nice little template
Warning = This template won't work on Solaris
Designer [EMAIL PROTECTED]
Programmer = Bob
--> userid NUMERIC = attribute explicitly passed into the fuse
<-- userID NUMERIC = attribute explicitly passed out of the fuse
--> [userID] NUMERIC = optional parameter passed out of the fuse
<--[userID] NUMERIC = optional parameter passed into the fuse
<-> userID NUMERIC = pass-thru variable (passed in AND out w/o change)
++> application.userID NUMERIC = global variable
+++ FILE.CFM = required include file
[+++] FILE.CFM = optional include file
END FUSEDOC--->
<!---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--->
------------------------------------------------------------------------------
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.
