コメントアウトいろいろ

ウェブサイト・ブログ作成

2018.08.31

この記事は約3分で読めます。

　コメントアウトはスタイルシートやHTML、PHPファイルなどに注釈を加えるときに使われる。

　コメントアウトした部分は、サイト上には表示されない。

　コードやスタイルが記載されていても、それが何だか分かりにくい場合が多いから、このコメントアウト覚えておいて損はない。

スタイルシートのコメントアウト

　スタイルシートのコメントアウトは「/* */」。

　使い方としては「/*（半角スペース）スタイルシートのコメントアウト（半角スペース） */」。

　/*の後ろに半角スペース。

　*/の前に半角スペースが入る。

HTMLのコメントアウトは「」。

使い方は「」。

　!--の後ろには半角スペース。

　-->の前にも半角スペース（全角でも大丈夫らしいが、ややこしいので半角スペースと覚えておいたほうが良いと思う）。

　HTMLのコメントの中で、-(ハイフン)を連続するとコメントの終了と解釈するブラウザがあるそうだ。

　なので、HTMLのコメントに「–」という文字列を使わないほうが無難。

　PHPファイルのコメントアウトは、いくつか書き方がある。

　コメントの頭に「//」を付けてコメントアウトする。

　次の行はコメントアウトされない。

　例）
<?php //ここからコメント
この行はコメントアウトされない。

　　スタイルシートと同様、「/*（半角スペース）コメント（半角スペース）*/」というように、コメントを囲む。

　/*の後ろに半角スペース。

　*/の前に半角スペースが入る。

　phpのタグの前で/**/を使用してコメントしても、エラーになるので注意。

ダメな例）
/* <?php
コメントアウトされずエラーになる */

　また、入れ子にするとやはりエラーになる。

ダメな例）
<?php /* 入れ子にすると
/* コメントアウトされず*/
エラーになる */

　コメントの頭に#を入れる。

　例）
<?php
#ここからコメント
この行はコメントアウトされない。

　いろいろな種類のあるコメントアウト。

　自分なりの使用ルールを決めておいたほうが良いかもしれない。

　コメント内で使えない文字もあるからなあ。

ちなみに、コメントアウトに使用する「/* */」、「」、「//」、「#」はすべて半角。

　全角で入力するとコメントアウトされないので注意。