2 things you should NOT do with commenting
1. state the obvious!
cfset x = x _ 1 !--- increments the counter by one ---
or my other fav
!--- gets the data ---
cfquery
...
/cfquery
2. Comment out large blocks of code. For some reason when taught
programming everyone gets the idea you should
the thought
that the code should be self-explanatory
everyone likes to think there code is self explanatory lol.
although it should be as self documenting as possible, you can comment so
the user doesn't have to view the whole code, like at the top of the page
give it a little description and
(pls forgive, gotta be quick)
there's the other parts to it as well, header info on the code files
explaining date, purpose, revision number, bug fixes, etc. Some people
build that into their source code control as automated/fill out the
form commits, etc.
then there's back to basics old
