There is something similar to this that the Fusebox folks use. It works
pretty well and is standardized. The theory is that you should be able to
wirte up your documentation about a page and then hand it over to someone
who doesn't know a thing about the project and they would still be able to
write the code. If you are interested, look up "Fusedocs" on
www.fusebox.org
Todd Ashworth --
Certified ColdFusion Developer
Network Administrator
Saber Corporation
314 Oakland Ave.
Rock Hill, SC 29730
(803) 327-0137 [111]
----- Original Message -----
From: "Jeffry Houser" <[EMAIL PROTECTED]>
To: "CF-Talk" <[EMAIL PROTECTED]>
Sent: Tuesday, April 03, 2001 7:25 PM
Subject: RE: Documentation (Was: Stupid Question? - Commenting Code That
Does Not Show in Browser)
|
| I use something similar to that on steroids:
|
| <!---
| Date: Self explanatory
| Creator: Jeff Houser, DotComIt (That way I get the credit--blame--when
| something goes wrong)
| Description: Blahblahblah self explanatory
|
| Entering: (I.E. where did we come from?)
| Exiting: (I.E. where are we going too?) (The entering / exiting stuff
| describes the flow of logic)
|
| Dependencies: (Usually I list custom tags here)
|
| Expecting: (What variables are we expecting to be defined when we enter
| this template? Are they URL variables? form variables? Are we going to
| assign default values if they are undefined or throw up an error)
|
| Modification History:
| I'm not great about this one, but typically I'll include the date, my
name
| / company, and a short description of the modifications.
| --->
|
| Yes, sometimes it can be tedious at times. As Arden said.. for my
| sanity. I don't list the name of the current file, because I figure any
| developer should know what file they are looking at.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Structure your ColdFusion code with Fusebox. Get the official book at
http://www.fusionauthority.com/bkinfo.cfm
Archives: http://www.mail-archive.com/cf-talk@houseoffusion.com/
Unsubscribe: http://www.houseoffusion.com/index.cfm?sidebar=lists
