PHPでコメントアウトする方法!プログラミング初心者にもわかりやすく解説

PHPでコードを書いている時に、

HTMLではできたのに、PHPではどうやってコメントアウトするかわからない
コメントアウトしたはずなのに上手く表示されない

と悩んだことのあるプログラミング初心者の方も多いのではないでしょうか。

コメントアウトはプログラミング言語によってその方法が異なります。

そこで今回は、

・そもそもコメントアウトとは何か
・PHPでコメントアウトする方法
・コメントアウトが上手くいかない時の対処法

をご紹介します。

コメントアウトとは何か

コメントアウトとは、プログラミングの際に特定の記号などを使い、記述したコードが処理されないようにすることです。

一時的に不要になったコードをコメントアウトして、必要となった時に再び復活させるという使い方もできます。

また、ぱっと見ただけでは機能がわかりづらいコードを書いた時、後から見てもわかりやすいように日本語でコメントを残すために使用することもあります。

本来、コードの中に日本語を書いてしまうとエラーになってしまいます。ですが、コメントアウトをした箇所はコードとして認識されなくなるため、日本語でわかりやすくコメントをすることもできるのです。

コメントアウトする時に使う特定の記号は、プログラミング言語によって異なります。また、この機能はPHPに限らずほぼ全てのプログラミング言語に存在します。

PHPでコメントアウトする方法3つ

コメントアウトが何かわかったところで、PHPでコメントアウトする方法を3つご紹介します。

行頭に「//」をつける

行頭に「//」をつけた箇所は、コメントアウトされてコードとして認識されなくなります。例えば以下のようにコードを書いたとします。

この場合、ブラウザに表示されるのは「Hello」のみです。

「ここをコメントアウト」「echo ‘World’;」の箇所は、コードとして認識されないので、ブラウザにも表示されません。

行頭に「#」をつける

同様に「//」をつけた箇所も、コメントアウトされてコードとして認識されなくなります。

この場合も、ブラウザに表示されるのは「Hello」のみです。

「ここをコメントアウト」「echo ‘World’;」の箇所は、コードとして認識されずブラウザにも表示されません。

コメント範囲を「/* */」で囲む

複数行まとめてコメントアウトしたい場合は「/* */」を使います。

この場合、ブラウザに表示されるのは「ここは表示されます」のみです。

「echo ‘Hello’; echo ‘World’;」はまとめてコメントアウトされているため、ブラウザに表示されません。

HTMLが含まれる場合のコメント

PHPはHTMLの中に記述できるため、HTMLとまとめてコメントアウトしたい場面もでてきます。

PHPのコメント「/* */」を使用する

このように、HTMLの中に埋め込まれたPHPもまとめてコメントアウトできます。

PHPでコメントアウト時によくあるミス

コメントアウトしたつもりが出来てなかった!ということはありませんか?そこでPHPでコメントアウトする時に、ミスしがちなポイントをご紹介します。

HTMLのコメントを使っている

HTMLでは「<!– –>」を使いますが、PHPのタグ内では使えません。

PHPタグの外でコメントアウトしている

逆にPHPタグの外で「/* /」を使っている場合も同様です。「/ */」はPHPタグの中でしかコメントアウトできません。

コメントが入れ子になっている

コメントをさらにコメントで囲っている入れ子構造になっている場合、コメントアウトできなくなります。

エディタのショートカットでコメントアウトする

コメントアウトしたい場所がたくさんある場合、いちいちコメントアウトの記号を入力するのは面倒ですよね。

コードを書くエディタに付属するショートカット機能を使えば、選択した箇所をまとめてコメントアウトすることもできます。

Atomの場合

  • Windows: Ctrl + /
  • Mac: Command + /

VSCodeの場合

  • Windows: Ctrl + /
  • Mac: Command + /

ショートカットキーを一度入力するとコメントアウト、もう一度押すとコメントアウトを解除できます。

使うエディタによってショートカットキーは異なるので、自分の使っているエディタが対応しているか調べてみるといいでしょう。プログラミングの効率がグンと上がってオススメです。

まとめ

以上、PHPでコメントアウトする方法について

・コメントアウトが必要な場面
・PHPでコメントアウトする方法3つ
・コメントアウトする時によくあるミス3つ

をご紹介しました。

PHPでコメントアウトする方法がわからない方、コメントアウトしたのに上手くいかない方はぜひ参考にしてみてくださいね。