Being the guy that wrote cfdoc and the guy that obviously started some kind
of cyber-turf war on what type of documentation we should use, I have to say
that the syntax I am using for cfdoc is modified from POD - Plain Old
Documentation - which has been used with Perl for years.
It is very successful and IS NOT used for version control. Documentation
and Version Control should be separate in my opinion because using cfdoc
syntax at the end of a page means that it is then part of each version of
the document and so is included as part of the version control by default.
I did not intend on writing something that was for fusebox architecture
solely, but for any text based format. I coded it in Cold Fusion because
it's quick and easy for me to do that. I could do it in Perl and make it
really cross platform. I already have one guy wanting to write the PHP
version of cfdoc. This is not a fusebox tool but a documentation tool, and
I put it out to get some feedback.
Cfdoc is v. useful for post-programming documentation, and also for
documenting something like a custom tag for other developers to use. It's
also easy to read in just it's textual format, meaning that it does not even
need it's browser, making it highly portable.
The reason I wrote it is to make it incredibly simple (not simple here) to
add documentation for any text based document. I have tried to understand
fusedoc but found it too complex (and I think a lot of people who don't use
fusebox would see it as a bit pointless) and as not all developers I work
with code in fusebox (something I am trying to change) then fusedoc is not
applicable to me as yet.
Please do not see this as an attempt to undermine anybody's documentation
systems. Cfdoc is a little programming language that is incredibly simple
and does a simple job with simple formatting. Please don't blow it up to be
the be all and end all of documentation of cold fusion (esp fusebox)
programming.
Thanks for reading this far!
Paul
PS Any feedback on adjustments/modifications that people think should be
made, email me.
------------------------------------------------------------------------------
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.
