regarding your tag line (sorry, couldn't resist) http://www.snopes2.com/cokelore/tadpole.htm > -----Original Message----- > From: John Wilker [mailto:[EMAIL PROTECTED]] > Sent: Tuesday, April 03, 2001 11:26 PM > To: CF-Talk > Subject: RE: Documentation (Was: Stupid Question? - > Commenting Code That > Does Not Show in Browser) > > > I got the model I use from the book "Code Complete" (ISBN: > 1-55615-484-4) > Which I highly recommend, it covers a wide range of "ways to > do things" and > points out the strengths and weaknesses. Helped me standardize my > development a lot. It's also good ammunition when trying to > explain why to > do something and the other party refuses to "take your word > for it" :-) > > J. > > John Wilker > Web Applications Consultant > Allaire Certified ColdFusion Developer > > Office: 909-943-8428 > www.red-omega.com <http://www.red-omega.com> > > The Coca-Cola name in China was first read as "Kekoukela", > meaning "Bite the > wax tadpole" or "female horse stuffed with wax", depending on > the dialect. > Coke then researched 40,000 characters to find a phonetic > equivalent "kokou > kole", translating into "happiness in the mouth." > > > -----Original Message----- > From: Todd Ashworth [mailto:[EMAIL PROTECTED]] > Sent: Tuesday, April 03, 2001 2:07 PM > To: CF-Talk > Subject: Re: Documentation (Was: Stupid Question? - > Commenting Code That > Does Not Show in Browser) > > > 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/[email protected]/ Unsubscribe: http://www.houseoffusion.com/index.cfm?sidebar=lists
