PHP: コメントの書き方 3通り

PHPのコメント

PHPでコメントを記述する方法は3通りあります。 単一行コメントの「//」と「#」、複数行コメントの「/*~*/」です。

単一行コメント① //(スラッシュ2つ)

単一行コメントの1つ目は「//」(スラッシュ2つ)です。

// から行末までをコメントとみなします。
行頭に // がある場合はその行全体がコメントとなり、 途中にある場合は // からがコメントとなります。

// 行頭に書く場合

$a = 0  // 途中に書く場合

単一行コメント② #(シャープ)

単一行コメントの2つ目は「#」(シャープ)です。

# から行末までをコメントとみなします。
行頭に # がある場合はその行全体がコメントとなり、 途中にある場合は # からがコメントとなります。

# 行頭に書く場合

$a = 0  # 途中に書く場合

「//」と「#」のどっちを使う?

単一行コメントは「//」と「#」の2種類あり、 どちらを使っても構いません。 ですが混在させると見にくくなりますから、 どちらか一方にした方が良いでしょう。

PHPのコメント記号として使われている割合で言えば 「//」の方が多いので、 どちらか迷ったら「//」を使っておけば大丈夫です。

複数行コメント /* */

複数行のコメントを記述する場合は「/* */」が使えます。 「/*」から「*/」までをコメントとみなします。

/*
この部分が
複数行コメントになります。
*/

ただし複数行の場合は「/* */」を使わずに、 単一行コメント記号を複数使う方法もあります。

// この部分が
// 複数行コメントに
// なります。