View comments | RSS feed

Commenting your code

As in other programming languages, it is important to include comments in the code. You should comment your code for the following reasons:

Commented code is easier to debug than code that is not commented.
If you describe the code on the page, it is easier to make modifications.
Commented code tends to be better organized.

Comment tag

The ColdFusion comment tag is similar to the HTML comment tag, except that it has three dashes instead of two:

<!--- This is a CFML comment --- >

ColdFusion comments are not returned to the browser because the ColdFusion server processes and omits the comments from the page. The user will never be able to read your comments.

Version 6

Comments are no longer accepted for ColdFusion MX. ColdFusion 8 is the current version.

Comments

blst said on Dec 3, 2004 at 5:31 PM :

I just wanted to be the first to leave a comment about comments. Totally.

champion_fella said on Mar 21, 2005 at 8:30 AM :

Hey, do you not have a standard for commenting Coldfusion code?

webcoder_pcc said on Mar 31, 2005 at 11:15 AM :

http://livedocs.macromedia.com/wtg/public/coding_standards/style.html

This is a start for commenting, but not the end. SVP, search "cfml commenting standards" or something along that manner.

RSS feed | Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/coldfusion/6/Getting_Started_Building_ColdFusion_MX_Applications/cfml_basics7.htm

Getting Started Building ColdFusion MX Applications
CFML Basics