あると助かる”コメントアウト”

コーディングをするうえで何かと便利でよく使うのがコメントアウト。

コメントアウトとは、HTML側に特殊な記号を用いて、
ソースコードなどを処理されないようにするためのテクニックです。
コメントアウトされたソースコートや文字列は、
処理されないのでブラウザ側では表示されないということになります。

ソースコード内のセクションごとに見出しを付けたり、ちょっとしたメモを記載するなど
オモテ側に見せる必要のない記述を非表示にしてくれる便利な機能で使用頻度も多いタグの一つです。

【コメントアウトってどう書くの?】

書き方はとても簡単で、HTMLの場合、表示させたくないソースコードや文字列を
「<!-‐」と「–>」挟み込むだけです。

ちなみに、CSSの場合は「/*」と「*/」を使い、
JavaScriptは、一行の場合は「//」、複数行の場合はCSSと同様「/*」「*/」で挟みます。
PHPでは、一行の場合は「//」や「#」、複数行の場合は「/*」「*/」を使います。

言語によって書き方は少し異なりますが、使う記号は少なく記述はとても簡単!

【コメントアウトの使い方はさまざま】

具体的にどういうときにコメントアウトを使うのか、主に以下の点が挙げられます。

・セクションごとに見出しをつけたい
・ソースコードがなんの部分かわかるようにしたい
・記述されたブログラムなどがなんの処理をしているかわかるようにしたい
・記述したソースコードを一定期間非表示にしたい(コメントアウト解除で再利用できる)
・デバッグしたいとき(プログラム処理エラー、表示エラー時のチェック)

コメントアウトをつけていることで、変更箇所が探しやすくなったり、
このプログラム記述は何だっけ?ってことを防いだりすることができるわけですね。

 

【コメントアウトを使うときの注意点】

コメントアウトは制作者のメモや覚え書き的に使用することがほとんどですが、
制作途中やページ公開後、別の人が編集を行うこともあるので、
相手にもなるべくわかりやすく書くことが重要になります。

また、やみくもに細かくコメントアウトを入れてしまうと、
ソースコードが見づらくなって編集しずらくなることもあります。
コメントアウトは見やすく、短く書くこともポイントですね。

今回はコメントアウトについて触れてみました。

【オマケ】
先日、クライアント様の楽天トラベルカスタマイズページのコーディングをしていると
公開ページに「an error occurred while processing this directive」というエラーが起きました。
いろいろ調べると、原因はコメントアウト内に記述した「#」記号でした。
楽天トラベルカスタマイズページのHTML内でコメントアウトするときは
「#」記号を使わないようにしましょう。

  • このエントリーをはてなブックマークに追加
  • follow us in feedly

何でもお気軽にお問い合せください。

お問い合せはこちら