いろいろ調べながらやってたのでメモがてらまとめておくことにした。

そもそもPHPDocumentorとは何か。

PHPDocumentor(略称PHPDoc)とは、JavadocのPHP版で、ソースコードに記入された一定形式のコメントに従って、仕様書を生成するプログラム。

詳しい解説については、JavadocのWikipediaに書いてあるのでそちらを参考のこと。

Javadoc – Wikipedia
http://ja.wikipedia.org/wiki/Javadoc

セットアップ作業

まずはPHPDocを使えるようにするためのセットアップ手順。

PHPDocのインストール

PHPDocを使うためには、まずPHPDocをインストールする必要がある。
インストール方法はPEARから簡単にできる・・・らしいけども、Windowsの場合はPEARからではなく直接ダウンロードしてきたほうがよい。
下記のGitダウンロードページから、最新版のphpDocumentorをダウンロードする。
一緒にソースコードも配布してるが、そちらは不要。

phpDocumentor
http://www.phpdoc.org/

ダウンロードページ(Git)
https://github.com/phpDocumentor/phpDocumentor2/releases

ダウンロードしてきたファイルを解凍し、適当なフォルダに保存する。
保存先はとりあえずどこでも可。

最後に、

インストール作業は以上でおしまい。

PHPDocumentorプラグインのインストール

続いてプラグインのインストール。

NetBeansを起動し、メニューからツール>プラグインを選択。
「使用可能なプラグイン」タブを選択して検索窓に「phpdoc」と入力すると、一覧に「php documentor」が表示されるので、チェックを入れて「インストール」ボタンを押す。

キャプチャ

画面の指示に従ってインストールを行えば、作業完了。

PHPDocの初期設定

最後に、PHPDocを利用できるように設定する。

NetBeansのメニューからツール>オプションを選択。

「PHP」の一般タブのコマンド行に、php.exeのフルパスを入力。XAMPPの標準インストールなら「c:/xampp/php/php.exe」になる。

キャプチャ2

同じく「PHP」のフレームワークおよびツールから「フレームワークおよびツール」を選択し、PHPDoc script欄に先ほどインストールしたフォルダの「bin/phpdoc.php」のパスを入力する。さっきと同じように、「browse」ボタンからも探せるので、そっちから探した方がいい。
最初はphpdoc.batを選択してたがうまく動作しなかったので、phpdoc.phpを指定することにした。

キャプチャ3

これで設定は終わり。この後、NetBeansを再起動しておくとより確実。

PHPDocの使い方

まずはソースコードにPHPDocのタグを書き入れる。(下記赤字部分)
下記はjavadocのwikipediaからPHP向けにカスタムしたもの。PHPDocのタグの書き方はJavadocのものと同じなので、そちらを参考に。

続いて、プロジェクトを右クリックしてドキュメントの生成>PHPDocを選択すると、出力先を聞かれるので、出力先をフルパスで指定してからOKボタンを押す

キャプチャ5

そうすると、勝手に生成が始まって、勝手にブラウザが起動する。
一応日本語も問題なく表示できてた。

キャプチャ6

とまぁこんな感じ。
後追いで記事を書いてるので、もしかしたら手順が抜けてるところがあるかもしれない。

追伸。

今回の記事を作成するにあたり、surfaceのペンを使って画像に直接文字を書き入れた。
こりゃ便利だわな。