トップ　>　php　>　

PHPコメントの書式｜単複コメントとPHPDoc書式と使い方と解説

PHPの単行複数行コメントの書き方、PHPDocの書式と使い方、全てのタグを解説。PHPDocタグの使用例をサンプルコードで分かりやすく解説した。

PHPのコメントは、//（単行）、#（単行）、/* */（複数行）の3つの書き方がある。
一般的には //（単行）、/* */（複数行）の2つを使用する。

この他に /** */ とすることで PHPDoc 用のコメントを記述できる。

/* */ は /* をコメント開始タグ、 */ をコメント終了タグとして認識し、タグの内側をコメントとして認識する。

複数行コメント 記述例
/* 複数行コメントを書く */

/*
　　  複数行コメントを書く
*/

/*
 *　　複数行コメントを書く
 */

他言語のコメント書式はコメントの言語別書式機能比較を参照。

/** */ は PHPDoc（ピーエイチピードック）と呼ばれ、メソッドの引数や戻り値の型、意味を記述するために使う。

これを書くことで、HTML形式のAPIドキュメントを生成したり、開発ツール（VSCodeやPhpStormなど）上でマウスを置いた時に型情報や説明文がポップアップ表示されるようになる。

基本コマンド
phpDocumentor（PHAR形式など）をインストールし、コマンドプロンプトやターミナルで、ソースファイルがあるディレクトリに移動して実行する。

-d [ディレクトリ名]: 対象となるPHPファイルがあるディレクトリを指定する（. はカレントディレクトリ）。

-t [出力先]: 生成されたHTML群を doc というディレクトリに出力する指定（ディレクトリ名は自由に変更可能）。

phpdoc -d . -t doc

オプション
特定のディレクトリやファイルを除外したり、タイトルを指定したりできる。

--ignore で除外するディレクトリやファイルを指定し、-f で特定のファイルを指定する。--title でドキュメントのタイトルを指定する。

phpdoc -d src -t docs --ignore "common/" --title "My PHP Project"

設定ファイル（推奨）
コマンドライン引数が長くなる場合、phpdoc.dist.xml という設定ファイルを用意することで、コマンド引数を省略して実行できる。

ミニファイを行うファイルにPHPのソースコードがあると改行コードが取り除かれてしまい、//、# でコメントを記述すると正しく機能しなくなる。

ミニファイを行う場合は、コメントは全て /* */ で記述する必要がある。