I am currently reading more on JavaDoc. I last read about it aaaaaaaaaaaaages ago, when i was lurking around for a good standard to document by. I now have a situation where i'd prefer to just have my system autodocument for me, and reduce the need for having to go and write lengthy API Word Doc's after I have finished an app (why not do it once i say).
I've decided to do this, by making my own Autodocumentation tool, that will scan an application based on the JavaDoc concept of commenting, as this will allow me to not only apply the same concept to cfmx code, but also to Javascript, Actionscript and even CSS! :D I've even gone a bit more sneakiererrerer, but yet still going out on a thin limb to spider SQL Statements or Calls to a database, and associate not only tables to a script file but also extract the tablenames & fields / stored procedures within an application to autodocument aswell (I'm not going to attempt automating the relationships of the table as that would be just a tad too much work :D) I say this as, Is it just me or has a concept like this been staring us all in the face at some point? and if so why hasn't anyone else adopted such a lazy way out? Do any of you out there that have a system like this or actually use JavaDoc find it an overkill or hassel to implement? or find problems with it at all? I'm curious, excited and yet sceptical if actually being this easy... (you know when you make something and its easy and you go... ummm that was just a little to easy, what did i frikin do wrong again) The Negative sideeffect to all this is: - Pattern Text Matchups require strict commenting practices, in that if use * @parm myvar description goes here it won't pickup the fact that its a @param (I however do have a "close to" system implemented, but you get the picture) - Each line requires the * to begin, this is so that the spidering is less of a bitch to text-hunt. - Retraining your brain from whatever your existing commenting style, to a new method. - Spiderscripterer has to be one the same machine / sandbox area as the application it is spidering. The Postive sideeffects to all this are: - Uniform way of commenting - Autodocumentation, aswell as version/history of particular files Now, Having SAID ALL OF THIS... Who here would buy it off me once i finish (goin cheap, $100 per cfmx server install).... Hey i got a babey on the way and i need a passive income source ;D Seriously, rekon its worth the effort or am i dreaming? --- Comment Example --- /** * Converts a list of variable names to a Flash safe string to pass into a Flash movie. * * @param varList A list of variable names, not the values themselves. * @param loadVar A variable to append to tell Flash the variables are loaded. * @param delim Optional delimiter. Defaults to a comma. * @return Returns a Flash safe string. * @author Joshua Miller ([EMAIL PROTECTED]) * @version 1, September 6, 2001 */ Scott. -- Freelance Application Developer / Designer -- ph: 07 3288 6702 mob: 04040 32812 -- url: http://www.spidaweb.com --- You are currently subscribed to cfaussie as: [email protected] To unsubscribe send a blank email to [EMAIL PROTECTED] MX Downunder AsiaPac DevCon - http://mxdu.com/
