Tuesday, April 26, 2005

the world of fusedoccing

off course i don't have to explain the good sed of documenting the code... but some years ago, we didn't have the same habits to document code. So these days, while upgrading some fusebox 1.0 applicatons to nowerdays standards (read all about fusebox methodology), we had to add lots of documentation in the scripts too. But fortunately some guys develloped tools to make our work much easier. I used three tools to automate the code documentation and i liked them!

AutoFusedoc is a plugin for Homesite/CFstudio. When pressing ctrl-shft-d it scans the current document and generates fusedoc including io-parameters it can find in the cf-code and the name of the current file. It saves you lots of hours for only $50,- (if you have applications of 1000+ files like we do)

There is a tool out there, fusedocer, with which you can automatically read all fusedocs from all files in your Fusebox 3 application and generate a nice report from it. We're currently improving the tool, to make it more stable (right now it crashes on simple cf-errors). When we're ready you can download it here. Those guys are working on a version for Fusebox 4.

Fusebox 3 to 4 converter: well if you've got your code in FB 3, why not change it to 4 and profit from the performance gain. It needs some manual fine tuning, but the xml-generation is perfect!

No comments: