Adobe ColdFusion 8 Web Application Construction Kit, Volume 1: Getting Started
by Ben Forta, Raymond Camden, Charlie Arehart
Commenting Style
Throughout this book, we encourage you to comment your code as much as possible. Any code, ColdFusion or otherwise, is a hundred times more valuable if it is thoroughly commented. And it becomes a thousand times more valuable if all the code for an application is commented in a consistent style.
You should decide ahead of time how you will comment your code, and stick to it while you work. For instance, you might make resolutions like these:
Each .cfm file should have a header comment that lists the purpose of the file, when it was first written, and the original author’s name.
When anyone makes a significant change to the file, the header comment should be amended, explaining which portions were added or changed. Over time, ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access