PHPでのコメントの書き方

コメントとは

コメントとは、プログラム中に書き込める注釈のことです。

コメントを書くことによって、どういった役割があるのか(クラス、メッソド、変数や定数等)すぐに第三者がプログラムを見た時にわかるので非常にコメントを書くことは重要です。

また自分自身も時間が経ってからプログラムを見た時に、コメントを読むことによって、瞬時にどんなプログラムだったか思い出すことができ、保守性が向上します。

コメントの書き方

コメントの書き方には、下記の3パターンがあります。

最初の2つは、//(ダブルスラッシュ)、もしくは＃(シャープ)の文字以降に、行末までの部分がコメントになります。

また、/* と */で囲むと、包括された部分はコメントになります。

下記は、複数行に渡ったコメントの例です。