ドキュメント生成ツール
- 一定の形式でコメント記入
- ソースをパースしてドキュメント化
- HTML, CHM, PDF, XML 対応
- vim プラグインもある
プログラムソースに、一定の形式に従ってコメントを記入しておく。ソースをまるごとパースすると、ドキュメントが自動生成される。
HTML, CHM, PDF, XML 形式で出力することも可能。
vim で phpdocumentor 用のコメントを書くプラグインがある。
インストール
- phpdoc.orgからダウンロード
- 解凍する 以上
- PEAR パッケージにもある
- ディストリによっては apt 等で可能
ダウンロードして、解凍するだけで OK。PhpDocumentor ディレクトリ内にある、phpdoc というシェルを実行すればよい。
PEAR 利用の場合は PEAR パッケージのほうが良いかもしれない。
ディストリビューションによっては、apt パッケージ等からインストールすることができる。この場合は /usr/share/php 等、php のあるディレクトリにインストールされるらしい。
