ステップ3 - コメント文

やってみようコード中にコメントを挿入する場合は、コメントの先頭に//を付けるか、/*と*/で囲みます。後者は複数行をまとめてコメントにする場合に便利です。コメントはPHPコードの実行時には無視されます。

どのような場合にコメントを使用する？

プログラムは誰が見るか分かりません。それは10年後の自分かもしれません。10年も経てば何のコードであるか、自分の書いたコードでも思い出すことは困難です。他人ならなおさらです。

従って基本的にはコメントは他の人が見た際に「何をやっているコードか」が分かるように記述します。但し記述するまでもなく分かるような処理には冗長になるためコメントを付ける必要はありません。

※このチュートリアルでは解説のために本来コメントする必要のないコードにもコメントしていますが、あくまでも特殊な例です。

また、/*と*/による複数行コメントは、コードの説明というよりは、ある範囲のコードを無効化して動作を確かめる場合、あるいはある処理を実施する際に複数の処理方法があるときにサンプルとして他の処理方法を残しておきたい場合に使用されます。

例えばある処理を実施する際に、Aという方法とBという方法がある場合、両方の動作を試したとします。試験の結果Aの方法を採用した場合、Bをコメントにしておきます。そうすれば後になってやはりBの方が処理が速い、Aでは一部の処理に問題があった、という場合にBに簡単に切り替えることができます。

また、後から他の人がコードを見たときに、Aの処理とBの処理の両方を試したこと、どのような理由でAの処理を採用したか、あるいは何故Bのコードは採用しなかったのかが分かればコードの理解が深まります。コメントは10年後の自分のためでもある事を覚えておきましょう。

$foo = 1; //ここからコメント

/* ここから
$foo = 2;
ここまでがコメント */

echo $foo;