コードにコメントを付けるのは、複数の開発者や後日のメンテナンス作業などに非常に有効な方法です。CFMLのコメントについて解説します。

シンタックスと使用例

コードにコメントを付ける方法は、HTMLにも用意されていますが、HTMLのコメントは画面には表示されないもののブラウザのソースには含まれているため適切ではありません。そこで、CFMLで用意されているコメントを使用します。CFMLコメントにすると、コメントに囲まれた範囲はColdFusionで処理が行われず、かつ、ブラウザのソースにも出力されません。そこで、開発者の名前や、ページの作成日・更新日、ページの処理の概要、更新情報などを書き、メンテナンス性を高めることが推奨されています。

HTMLのコメントは

<!-- ここに HTML コメントを書きます -->

上記の場合、画面には表示されませんが、ブラウザのソースにはこのコードが残っています。そこで、ColdFusionコメントに変えてみましょう。CFMLコメントは下記のように、HTMLのコメントがハイフン2つに対して、ハイフン3つを指定します。

<!--- ここに CFML コメントを書きます --->

CFMLのコメントをページの先頭付近に書いておけば、ページの内容や作成者を共有できます。

<!---
ファイル名： test.cfm
ファイル内容：ユーザーの詳細情報を画面に表示
作成者：サムライズ太郎
作成日：2012/4/10
更新日：2013/5/1
備考：
　修正履歴
　　2012/6/12 XXXX
　　2012/9/3 XXXX
　　2013/1/29 XXXX
 --->