Alrighty then,
I have re-worked my parser to handle multiple comments in a single
comment-block, delimited by !---@, for want of something better ;-)
I have also made the parser more robust in a few ways. It can now handle
CommentTypes with spaces and other punctuation (not ":" of course!).
The order of the CommentTypes within the code is now returned in an array,
not a list, to get around problems with delimiters. As a result, the
display page (dsp_Files.cfm) has also changed.
You can get the whole shebang at http://bjork/net
I look forward to any feedback.
thanks heaps,
Lee (Bjork) Borkman
http://bjork.net ColdFusion Tags by Bjork
-----Original Message-----
From: BORKMAN Lee [mailto:[EMAIL PROTECTED]]
Sent: Tuesday, August 29, 2000 11:09 AM
To: '[EMAIL PROTECTED]'
Subject: RE: FuseDoc specification
Okay all,
I can certainly see the benfit in containing multiple comments within a
single <!--- ---> pair. The problem, of course, is that you then need to
define another delimiter, and thus restrict what can be included in the
CommentContent. "*" is probably not a good idea, as has been pointed out.
"!---@" is pretty sensible, though not particularly elegant. Still, not
much can be done about that - HTML and CF comments are pretty ugly to start
with.
So, we start with a simple FuseDoc comment like this:
<!---@ Description: This is a very nice piece of code --->
That would still be legal, and should still be allowed at any point in the
code. NOW, we also allow additional comments to be added in the same
comment-block:
<!---@ Description: This is a very nice piece of code,
although it could really be a bit more elegant.
!---@ Author: Lee Borkman
!---@ Programmer: Frances Borkman
!---@ Attribute: -->[C_Room]: The unique ID of a room to be booked
!---@ Attribute: <--Rooms: A WDDX query of Rooms data
--->
Obviously, this saves a closing "--->" for every comment in the block, while
retaining the "!---@" opening delimiter characters.
A QUESTION. Is this really any more readable? I'm not sure. Nevertheless,
this format could be encompassed within the standard (or guideline), and
users would be free to use it if and when they please. I have a feeling
that I would still stick with one comment per block for my code, just for
simplicity's sake. Here is the one-comment-per-code version of the same
information:
<!---@ Description: This is a very nice piece of code,
although it could really be a bit more elegant. --->
<!---@ Author: Lee Borkman --->
<!---@ Programmer: Frances Borkman --->
<!---@ Attribute: -->[C_Room]: The unique ID of a room to be booked --->
<!---@ Attribute: <--Rooms: A WDDX query of Rooms data --->
You see, there are no worries about how to indent, whether to put the
opening and closing <!---@ and ---> on a separate line, etc. Still, all of
this can certainly be included in the guidelines, and can be parsed without
much problem. I'll see if I can amend and post a new parser later today,
Sydney-time ;-)
Thanks for all the input everyone,
Bye for now,
Lee 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.
