コメントの書き方

このレッスンでは、PHPにおけるコメントの書き方を学び、あとから読み返しても分かりやすいコードを書けるようになることを目標にします。「PHP コメントアウト 書き方」で調べている方向けです。

コメントは、実行には影響しない「人間向けのメモ書き」です。//または#で1行、/* */で複数行のコメントになります。「なぜこの処理が必要なのか」という背景を書き残しておくと、あとで見返したときに大いに役立ちます。

サンプルコードでは、//と#という2種類の1行コメント記法と、/* */による複数行コメントを試しています。PHPでは1行コメントに2つの書き方があるのは珍しい特徴で、チームやプロジェクトによってどちらを使うかのルールが決められていることもあります。

初心者がよくつまずくのが、コメントを書きすぎてしまい、かえってコードが読みにくくなるケースです。「何をしているか」はコード自体を読めば分かることが多いため、コメントには「なぜこの処理が必要なのか」という背景を書くのが効果的です。

一時的にコードを無効化したいとき(コメントアウト)にもよく使われる、実務でも欠かせない書き方です。デバッグ時に特定の行だけを一時的に無効化して動作を確認する、という使い方も頻繁に行われます。