コメント

PHPにおける「コメント」とは、プログラムの中で実行されないメモ書きのようなもので、ソースコードの可読性を高めたり、後からコードを見返す際の手助けをしたりするために使われます。コメントは、開発者自身や他のプログラマがコードの意図や仕組みを理解するための重要な手段です。

---

コメントの種類

PHPでは、主に以下の3種類のコメント記法が用意されています。

1. 一行コメント（シングルラインコメント）

一行コメントは、行の途中または末尾に短い説明を加えるときに使います。

php
// これは一行コメントです
echo "こんにちは"; // ここも一行コメントです

または

php
# これはシェル風の一行コメントです

• // または # 以降、その行の終わりまでがコメントとして扱われます。

---

2. 複数行コメント（ブロックコメント）

複数行にわたるコメントや長文の説明には、ブロックコメントを使います。

php
/*
  これは複数行にわたるコメントです。
  必要に応じて、詳細な説明を書くことができます。
*/
echo "こんにちは";

• /* と */ の間にあるすべての内容がコメントとして無視されます。

---

コメントの使用例

php
<?php
// ユーザー名を表示する
$name = "田中太郎";
echo $name;

/*
 この部分ではユーザーの
 年齢情報を処理します
*/
$age = 25;
echo $age;
?>

---

コメントの活用ポイント

• コードの説明：なぜこの処理を行っているのかを補足する。

• 仮実装のメモ：後で書き直す予定の箇所を記録する。

• デバッグ用の一時的な無効化：コードを一時的に無効にしたいときにコメントアウトする。

php
// echo "これは表示されません"; // デバッグのために一時的に無効化

---

注意点

• 過度なコメントはかえって可読性を下げることがあります。簡潔に、要点を明確に書くことが大切です。

• コメントにコードの動作そのものを書くのではなく、「なぜそのコードが必要なのか」に焦点を当てると有効です。