As a fusebox user, I like my Fusedocs. Fusedocs are comments you place in each of your code files that describe WHAT the file needs to accomplish, and what data is going in and out of it. The in/out idea is reminiscent of preconditions/postconditions. Fusedocs are written using a standardized set of easy to write/easy to understand XML tags - and using XML is a plus if you decide to start writing utilities that parse documentation for useful info. The idea is that you write the fusedoc BEFORE you write the code, and it becomes a specification for the file, a sort of contract that the code/coder fulfills. This might seem a little backward, but it really helps in writing high quality documentation, and it's good for the quality of your code too.
Anyway, I have found that Fusedocs can be useful outside of the context of Fusebox, though it is harder to follow Fusedoc conventions as rigoursly in that case. Here's some URLs about Fusedocs, if you're interested: http://www.halhelms.com/index.cfm?fuseaction=newsletters.halsteve&issue=8 http://www.halhelms.com/index.cfm?fuseaction=newsletters.halsteve&issue=9 http://www.meta-magic.com/cgi-bin/fusewiki?action=browse&id=FuseDoc&oldid=FuseDocs http://www.halhelms.com/index.cfm?fuseaction=code.detail has lots of samples Enjoy! Mike Mertsock Alfred University Web Team >As our applications get more complex, documenting new apps, and mods to >existing apps is becoming increasingly important. It's time to abandon the >old "notes on napkins" methodoolgy for something a little better. Does >anyone use a documentation tool for recording details of complex >applications? Maybe a standard set of forms? > >Any recommendations are greatly appreciated. > >BG ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~| Archives: http://www.houseoffusion.com/lists.cfm?link=t:4 Subscription: http://www.houseoffusion.com/lists.cfm?link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=89.70.4 This list and all House of Fusion resources hosted by CFHosting.com. The place for dependable ColdFusion Hosting. http://www.cfhosting.com
