ColdFusion基礎プログラミング



2-15コードにコメントを付ける

開発中のアプリケーションのメンテナンス性を確保する手助けとして、コードには可能な限り詳細にコメントを付けるようにします。


コメントの作成

テキストの行やブロックを <!--- と ---> で囲むことでColdFusion コメントを作成することができます。
エディタ画面上のツールバーにショートカットがあります。


以下のような、ダッシュ(-)を2 つだけ使ったHTML コメントには馴染みがあるでしょう。

<!-- これは HTML コメントです -->


ColdFusion コメントは、2つのダッシュの代わりに3つのダッシュを使う以外の点はHTML コメントと同様です。

<!--- これは CFML コメントです --->


HTML コメントとは違い、ColdFusion コメントはブラウザに送信されず、ページから省略して処理されます。従って、リクエスト元のユーザーはコメントを読むことができません。

コメントの活用例

開発を行いながら、自由にページにコメントするとよいでしょう。ページの最上部にコメントブロックを作成する場合の一例を紹介します。

<!---//------------------------------------------------
Name/Copyright: ページ作成者の名前や会社、コピーライトなど
Created: ページの作成日
Update: ページの更新日
Purpose:ページの処理内容.
-------------------------------------------------//--->