Lee,
First off...my team likes your stuff. Keep it up!
I'd like to get your comments on this. I admit that this is a detail.
What do you, and anyone else that cares to comment, think about taking the
CF comment tags out of the middle of documentation blocks? It's not a
parsing problem and it does increase readability.
<!---**
* general description for the file.
*
* @Designer: Who Ever (e-mail)
* @Programmer: Who Else (e-mail)
* @Attributes: --> [directory]: An absolute directory (eg, c:\cfdocs\)
* @Attributes: <-- etc.....
*--->
Method used now:
<!---@ Description: general description for the file. --->
<!---@ Designer: Who Ever (e-mail) --->
<!---@ Programmer: Who Else (e-mail) --->
<!---@ Attributes: --> [directory]: An absolute directory (eg, c:\cfdocs\)
--->
<!---@ Attributes: <-- etc..... --->
Phil Hulsey
-----Original Message-----
From: BORKMAN Lee [mailto:[EMAIL PROTECTED]]
Sent: Sunday, August 27, 2000 7:56 PM
To: '[EMAIL PROTECTED]'
Subject: Re: FuseDoc specification
Okay, I give in.
Due to lack of interest on CF-Talk, let's keep this on the FuseBox list for
now. I still want to insist on a general syntax that is not
FuseBox-specific.
As for PDL, I must admit that I'm a bit of a fan. What I'm looking for,
though, is a general documentation syntax that can be used for PDL's
comment-first development, or PragmaticProgrammers' code-by-contract
development, or any process that you happen to fancy. You could, for
example, have comments like this:
<!---@ PDL: Keep track of current number of resources --->
<!---@ PDL: If another resource is available --->
<!---@ PDL: Allocate a dialog box structure --->
etc
etc
(example from Steve McConnell's Code Complete).
This could be parsed out and displayed along with all your other <!---@
comments.
Just need some way to handle indenting, though I guess you could just put
tabs in the CommentContent??
Lee (Bjork) Borkman
http://bjork.net ColdFusion Tags by Bjork
----------------------------------------------------------------------------
--
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.
------------------------------------------------------------------------------
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.
