apgen

以前 PHPDocumentor を試してみたんですけど、出力されたドキュメントがイマイチ見にくいのと、ページレベルのコメントを拾ってくれなかったので、代替ツールを探してみた所、ApiGen がなかなか良さげです。

ApiGen | API documentation generator for PHP 5.3

 


インストール

pear でさくっとインスコできます。

pear config-set auto_discover 1
pear install pear.apigen.org/apigen

include_path に pear と texy を追加

vi /private/etc/php.ini

include_path = "/Users/me/pear/share/pear:/Users/me/pear/share/pear/texy/src:."

 


使い方

apigen –source ~/path/to/phpsrc –destination ~/path/to/output

残念ながら期待していたページレベルのコメントは拾ってくれませんでしたが、functionのコメントとかは綺麗にドキュメントが出力できました。なかなかいいです。

 


参考にさせて頂いたサイト

PHPのドキュメンテーションツールはApiGenがいい感じなんじゃないか