第4章 PHPプログラムの基本
4.6 コメント文で説明を書こう
コメント文とはPHPプログラムの中に書き込む注釈のことです。コメントは単なる説明文なので、プログラムの実行には影響はありません。
【コメントを書く目的】- プログラムの説明文を書いておく。(プログラム名、概要、作成者、作成日など)
- 記述しているPHP処理がどのようなことをやっているかを書いておく。
- 修正時の失敗を考慮して、修正前のソースコードを一時的にコメント化しておく。
コメント文をきちんと書いておくと、自分自身が見返した時にいつ作成したのか、どのような処理をやっているのかすぐに分かるので大変便利です。
書式：PHP処理内のコメント文
最初の2つは、「//(半角スラッシュを2個)」、もしくは「#(半角シャープを1つ)」の文字以降、行末までの部分がコメントになります。また「/* */(スラッシュとアスタリスク)」で囲むと、囲まれた部分全てがコメントになります。
凡例：PHP処理内のコメント文
凡例のように単一行コメントは各処理の説明を端的に書く場合に利用し、複数行コメントはプログラムの説明文や長文コメントを書く場合に利用するのが一般的です。また、業務でプログラムを行う場合、コメントのルールについて指定されることが多いので、それに従って書くようにしましょう。
プログラミングに慣れないうちは、プログラムの作成に集中してしまいコメントを書くことを忘れてしまいがちです。コメントはいつ書いても良いので、まずはプログラムが完成したら書いてみるようにしてみて下さい。慣れてくればプログラミングしながら記述できるようになるでしょう。
コメント文は自分のためでもありますが、第3者に見てもらう時にも必ず役に立ちますので、面倒くさがらずになるべく書くように心がけて下さい。
HTML内でのコメント文の書き方PHPでコメントが書けるようにHTMLにもコメント文を書くことができます。
<!– コメント文 –>
HTMLでは上記のような「<!– –>」タグで囲まれた範囲全てがコメントになります。