PHP コメントの書き方

概要

コメントアウトとは

「プログラムの中に書き込まれた、処理の記述以外の説明文のことをコメントという。」

コメントアウトを使うポイントとしては、メモとして使ったり、
プログラムを一時的に処理しない状態にしたり、
PHP Docというクラスやメソッドの定義前に決まったフォーマットでブロックコメントをすることでドキュメントを自動生成できたりします。

PHPのコメントアウトをしてみる

１行コメント // ・ #

<?php
echo 'プログラミングのテストです。出力されます1。';
//ここは１行コメントになり出力されません。

echo '出力されます２。';

# この行は１行コメントになり出力されません。

echo '出力されます3'; // ここから出力されません。

ブロックコメント /* */

<?php
echo '出力されます1';
/*
 * このブロックは出力されません。
 * ここも出力されません。
 */
echo '出力されます2';

PHP Docサンプル

クラス Class

<?php
/**
 * クラスの１行説明
 *
 * クラスの詳細説明
 * 複数行記述ができます。
 *
 * @access アクセスレベル
 * @author 名前 <メールアドレス>
 * @copyright 会社名 All Rights Reserved
 * @category カテゴリー
 * @package パッケージ
 */

メソッド Function

<?php
/**
 * メソッドの１行説明
 *
 * メソッドの詳細説明
 * 複数行記載することができます。
 *
 * @access アクセスレベル
 * @param int    $id paramは引数を書きます。
 * @param string $name 
 * @return boolean 返り値の型と説明を書きます。
 */
function is_test($id, $name)
{
    return false;
}

まとめ