PHPでコメントの書き方と使用方法を学ぼう


  1. 1行コメント: 1行コメントは、コードの特定の行に対して説明やメモを追加するために使用されます。コメントは行の先頭に「//」を置くことで作成できます。 例:

    // この行は変数の初期化です
    $name = "John";
  2. 複数行コメント: 複数行のコメントは、複数の行にわたる説明やメモを追加するために使用されます。コメントは「/」で始まり、「/」で終わります。 例:

    /*
    このコードブロックは、データベース接続の設定を行います。
    ホスト名、ユーザー名、パスワードなどの詳細が含まれています。
    */
    $dbHost = "localhost";
    $dbUser = "root";
    $dbPass = "password";
  3. ドキュメンテーションコメント: ドキュメンテーションコメントは、関数やクラスの説明、パラメータ、戻り値などの情報を提供するために使用されます。これらのコメントは関数やクラスの前に「/」で始まります。 例:

    /
    * この関数は2つの数値を加算します。
    * 
    * @param int $a 加算する数値
    * @param int $b 加算する数値
    * @return int 加算結果
    */
    function add($a, $b) {
       return $a + $b;
    }

コメントを適切に使用することで、自分自身や他の開発者がコードを理解しやすくなります。また、コメントはデバッグやコードのメンテナンス時にも役立ちます。