【PHPプログラミング入門講座】コメント

コメントとは

自分が書いたプログラムをしばらく経ってから読んだ時、「プログラム内容を理解し直す必要がある」「何の処理だったかすぐに思い出せない」場合があります。
そのような問題を防ぐために、プログラムコードの近くにメモを書いておくと便利だと思います。
PHPを含むプログラミングの世界では、このメモのことを「コメント」といいます。
今回は、PHPプログラムのコメントについて説明します。

コメントの記述方法

PHPプログラムには「単一行用のコメント」と「複数行用のコメント」があります。

単一行用コメント

単一行用コメントは「 // 」(ダブルスラッシュ)を使います。
ダブルスラッシュは「 / 」(スラッシュ)を2連続で書きます。
プログラム内で「 // 」(ダブルスラッシュ)を書くと、その後の記述内容はプログラムとして認識されなくなります。
よって、日本語の文章など自由に書くことができます。

記述例1：プログラム処理の上にコメントを書く場合

<?php
  //○○の計算をする
  $answer = $num1 * $num2;

記述例2：プログラム処理の後ろにコメントを書く場合

<?php
  $site = 'ABCDE'; //○○を設定する

記述例3：単一用コメントを使って複数行に渡りコメントを書く場合

<?php
  //この処理は○○○です。
  //この処理は○○○です。
  //この処理は○○○です。
  $value = $value1 * ($valu2 + $value3);

複数行用コメント

コメントの内容が長く、複数行に渡りコメントをする場合は、「 // 」(タブルスラッシュ)を使用すると、前述の例のように全ての行に対して「 // 」を記述する必要があります。
これでも良いのですが、複数行用コメントの記号「 /* 」と「 */ 」でコメントにする文章をはさむと、複数行を簡単にコメントすることができます。

記述例1：複数行に渡りコメントを書く場合

<?php
  /*
  この処理は○○○です。
  この処理は○○○です。
  この処理は○○○です。
  */
  $value = $value1 * ($valu2 + $value3);

記述例2：複数行用コメントの記号を使って、1行をコメントにすることもできます。

<?php
  /* この処理は○○○です。 */
  $value = $value1 * ($valu2 + $value3);

コメントアウト

コメントが使われた箇所はプログラム処理されないということが分かりました。

このコメントの性質を利用すると、一時的に処理をさせたくないプログラム処理がある場合に、そのプログラム処理を消すのではなく、コメントを使って記述を残したままにすることができます。
このプログラムを部分的にコメントにすることを「コメントアウト」と呼びます。

コメントアウトすれば、もし後でそのプログラム処理が必要になった場合に、コメントの記号「//」「/* */」を消すだけで簡単に復活させることができます。

＜コメントアウトの記述例＞

<?php
  //$str = $num1 * $num2;
  $str = $num3 * $num4;

上記の例の場合「//$str = $num1 * $num2;」の行がコメントアウトされているため処理されません。

おわりに

今回はコメントについて説明しましたが、いかがでしたでしょうか？

自分の覚書としてコメントを書くのはもちろんですが、複数人で開発することになった場合に、自分のプログラムを他のプログラマーが読んで理解できるためにも、コメントはできるだけ書く習慣を身につけましょう。