
Contents > Getting Started Building ColdFusion MX Applications > CFML Basics > Commenting your code

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.


Contents > Getting Started Building ColdFusion MX Applications > CFML Basics > Commenting your code

Version 6.1

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

Comments

wbare said on Jan 9, 2004 at 9:32 AM :

There should not be a space between the closing --- and the closing >

The example shows --- > but should show --->

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

Current page: http://livedocs.adobe.com/coldfusion/6.1/htmldocs/cfml_b24.htm