phpのソースにjavadoc形式で書いたコメントからドキュメントを自動生成するにはphpDocumentor(phpdoc)というツールを利用します。
自分はWindowsにPleiadesでxamppの環境を構築しています。
この場合最初からphpdocが入っているのですが、そのままだとphpDocumentor.iniがないとか言われてうまく動きません。
phpDocumentorの公式ページからインストール方法を確認すると、pearでさっくり入るように書いてあるのですが、それだとエラーが発生し(Error: failed to mkdir c:/php/pear/data/phpDocumentor/features/generates-documentation/create-documents-using-twigs)うまく入れることが出来ませんでした。
そこで情報漁ってみると、一旦デフォルトで入っているものをアンインストールするとうまく入るということがわかりました。
ポイント3つ!phpDocumentor を Pleiades All in One 日本語ディストリビューションで使うための設定!!! | oki2a24
http://oki2a24.com/2012/08/17/3-points-to-install-phpdocumentor-in-pleiades-all-in-one/
やり方をまとめました。
・コマンドプロンプトを管理者で開く
・pear自体のアップグレードを行う
> pear upgrade PEAR
・xamppで既に入っているphpDocumentorのバージョンが1.x系か確認
> pear list
で「phpDocumentor 1.4.x」が入っていることを確認する。
・既に入っているphpDocumentorをアンインストール
> pear uninstall PhpDocumentor
・2.x系のphpDocumentorをインストール
> pear channel-discover pear.phpdoc.org > pear install phpdoc/phpDocumentor
公式サイトの案内通り。で今だと「phpDocumentor 2.2.0」が入る。
・使ってみる
> phpdoc -d Model -d View -d Controller -t doc/phpdoc
ブラウザで doc/phpdoc/index.html を開く