コメントで説明を書こう

4.4 コメントで説明を書こう

　コメントとはPHPプログラムの中に書き込むことのできる注釈のことです。コメントはプログラムの実行には影響しません。

　【コメントを書く目的】
　　・プログラムの説明文を書いておく。（プログラム名、概要、作成者、作成日など）
　　・記述しているPHP処理がどのようなことをやっているかを書いておく。
　　・修正時に失敗してしまうこと考慮して、修正前のソースコードを一時的にコメント化しておく。
　コメント文をきちんと書いておくと、プログラムを作成してからしばらく時間が経ってから見返した時に、いつ作成したのか、どのような処理をやっているのかすぐに分かるので大変便利です。また、そのプログラムを見た第三者にとってもわかりやすいです。コメントは以下のような書き方があります。

書式：変数を別の変数に代入する

　最初の2つは、「//（半角スラッシュを2個）」、もしくは「#（半角シャープを1つ）」の文字以降の行末までの部分がコメントになります。また3つ目のように「/*　*/（スラッシュとアスタリスク）」で囲むと、囲まれた部分全てがコメントになります。

凡例：PHP処理内のコメント文

　業務でプログラムを行う場合、コメントのルールを指定されることが多いので、それに従って書くようにしましょう。
　プログラミングに慣れない初心者のうちは、コメントを書くことをつい忘れてしまいがちです。コメントを書くタイミングはいつでも良いのですが、まずはプログラムが一通り完成したら書いてみるようにしてみて下さい。慣れてくればプログラミングを記述しながら同時にコメントを書くことができるようになるでしょう。
　コメント文は自分のためでもありますが、第三者に見てもらう時にも必ず役に立ちますので、面倒くさがらずにしっかり書くように心がけて下さい。