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.
At 03:34 PM 04/03/2001 -0400, you wrote:
>I find it very helpful to put the following
>at the top of every CFM page -- for my sanity
>-- if it helps others that's fine too.
>
><!------------------------------------
>PROG: SHP_PRP.CFM
>WHAT: Lists shipments approved for
> transmittal to DoS as they are
> being stuffed into SHIP.TXT file
>-------------------------------------->
>
> ^
> / \__
> ( @\___
> / O
> / (_____/
>/_____/
>Whoof...
>410-757-3487
>
>-----Original Message-----
>From: Steven A. del Sol [SMTP:[EMAIL PROTECTED]]
>Sent: Tuesday, April 03, 2001 2:52 PM
>To: CF-Talk
>Subject: Re: Stupid Question? - Commenting Code That Does Not Show
>in Browser
>
>If you are using CF just put in three dashes instead of two...
><!--- Code ---->
>
>
>
>At 12:34 PM 4/3/2001 -0600, you wrote:
> >I want to place comments in the code for the other developers. However I do
> >not want the comments to show up in the browser with "view source." Am I
> >totally overlooking something?
> >
> >Thanks,
> >Jeff
> >
> >
>
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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
