PHPでコードを書いている時に、
HTMLではできたのに、PHPではどうやってコメントアウトするかわからない・・・
コメントアウトしたはずなのに上手く表示されない！！
と悩んだことのある初心者も多いはず。
コメントアウトはプログラミング言語によってその方法が異なる。
そこで今回は、
- そもそもコメントアウトとは何か
- PHPでコメントアウトする方法
- コメントアウトが上手くいかない時の対処法
を簡単にまとめた。
コメントアウトとは何か
簡単に言うと、特定の記号などを使って「ここのコードは処理しないで！」って記述すること。
一時的に不要になったコードをコメントアウトして、必要となった時に再び復活させるという使い方もできる。
また、ぱっと見ただけでは機能がわかりづらいコードを書いた時、後から見てもわかりやすいように日本語でコメントを残すために使用することも。
本来、コードの中に日本語を書いてしまうとエラーになる。
が、コメントアウトをした箇所はコードとして認識されなくなるので、日本語でわかりやすくコメントをすることもできる。
コメントアウトする時に使う特定の記号は、プログラミング言語によって違う。
さらに言うと、この機能はPHPに限らずほぼ全てのプログラミング言語に存在する。
PHPでコメントアウトする方法3つ
コメントアウトが何かわかったところで、PHPでコメントアウトする方法を3つ紹介する。
行頭に「//」をつける
行頭に「//」をつけた箇所は、コメントアウトされてコードとして認識されなくなる。
例えば以下のようにコードを書くと、
<?php
echo 'Hello'; //ここをコメントアウト
// echo 'World';
?>
ブラウザに表示されるのは「Hello」のみ。
「ここをコメントアウト」や「echo 'World';」の箇所は、コードとして認識されないので、ブラウザにも表示されない。
行頭に「#」をつける
同様に「//」をつけた箇所も、コメントアウトされてコードとして認識されない。
<?php
echo 'Hello'; #ここをコメントアウト
# echo 'World';
?>
この場合も、ブラウザに表示されるのは「Hello」のみ。
「ここをコメントアウト」や「echo 'World';」の箇所は、コードとして認識されずブラウザにも表示されない。
コメント範囲を「/* */」で囲む
複数行まとめてコメントアウトしたい場合は「/* */」を使う。
<?php
/*
echo 'Hello';
echo 'World';
*/
echo 'ここは表示されます';
?>
この場合、ブラウザに表示されるのは「ここは表示されます」のみ。
「echo 'Hello'; echo 'World';」はまとめてコメントアウトされているため、ブラウザに表示されない。
HTMLが含まれる場合のコメント
PHPはHTMLの中に記述できるため、HTMLとまとめてコメントアウトしたい場面もあるはず。そんな時はこの方法で。
PHPのコメント「/* */」を使用する
<pre class="lang:default decode:true">
<html>
<head>
<title>PHPのコメントアウト</title>
</head>
<body>
<?php
/*
<p>コメントアウトされます</p>
<?php echo 'ここもコメントアウトです'; ?>
*/
?>
</body>
</html>
このように、HTMLの中に埋め込まれたPHPもまとめてコメントアウトできる。
PHPでコメントアウト時によくあるミス
「コメントアウトしたつもりが出来てなかった！」ってことは初心者にはありがち。
そこで、PHPでコメントアウトする時にミスしがちなポイントを紹介する。
HTMLのコメントを使っている
HTMLでは「<!-- -->」を使うが、PHPのタグ内では使えない。
<?php
<!--
echo ここはコメントアウトできない;
-->
?>
PHPタグの外でコメントアウトしている
逆にPHPタグの外で「/* /」を使っている場合も同様。「/ */」はPHPタグの中でしかコメントアウトできない。
<div>
/*<p><?php
echo 'コメントアウトされません';
?></p>*/
</div>
コメントが入れ子になっている
コメントをさらにコメントで囲っている入れ子構造になっている場合、コメントアウトできない。
/*
echo 'コメントアウトされます';
echo 'コメントアウトされます';*/
echo 'コメントアウトされません';*/
エディタのショートカットでコメントアウトする
コメントアウトしたい場所がたくさんある場合、いちいちコメントアウトの記号を入力するのは面倒。
コードを書くエディタに付属するショートカット機能を使えば、選択した箇所をまとめてコメントアウトすることも可能に。
Atomの場合
- Windows: Ctrl + /
- Mac: Command + /
VSCodeの場合
- Windows: Ctrl + /
- Mac: Command + /
ショートカットキーを一度入力するとコメントアウト、もう一度押すとコメントアウトを解除できるんで便利。
使うエディタによってショートカットキーは異なるので、自分の使っているエディタが対応しているか調べるのがおすすめ。それだけでプログラミングの効率がグンと上がる。
まとめ
以上、PHPでコメントアウトする方法について
- コメントアウトが必要な場面
- PHPでコメントアウトする方法3つ
- コメントアウトする時によくあるミス3つ
を紹介した。
PHPでコメントアウトする方法がわからない人や、コメントアウトしたのに上手くいかないっていう人は参考にしてほしい。
かずきち
プログラミング学習サイト「ウェブカツ!!」の顧問。
不動産、保険の営業マンから、エンジニアへ転身。
「HTMLって何？」という状態から3ヶ月の独学のみでエンジニアへ転職し、１年で年収１千万を稼ぐエンジニアへ。
独学時代のプログラミング学習の分かりにくさや、「技術しか出来ずに稼げていないエンジニア」の現状を変えるため「ウェブカツ」を立ち上げ運営している。
【ウェブカツ公式WEBサイト】
https://webukatu.com/