読者です 読者をやめる 読者になる 読者になる

takafumi blog

日々の勉強メモ

phpDocumentorをインストールして使ってみる

環境   CentOS 7.0 PHP 5.6 phpDocumentor 2.8.2

簡単にphpDocumentorを使ってみた。
phpDocumentor

Composerを使ってインストールもできるが、もっと簡単にpharを使う。

pharをダウンロード

$ cd /path/to/bin
$ wget http://phpdoc.org/phpDocumentor.phar .
$ ln -s phpDocumentor.phar phpdoc

クラス図の生成も行いたい場合は、Graphvizもインストール。
図を生成しないならインストールしなくても使える。

$ yum install graphviz graphviz-gd

生成は以下のように

$ phpdoc -d /path/to/application -t /output/doc/path --template=clean

これで/output/doc/path以下にhtmlが生成されるので、それをブラウザから見る事ができる。

templateは

$ phpdoc template:list
Available templates:
* abstract
* checkstyle
* clean
* new-black
* old-ocean
* responsive
* responsive-twig
* xml
* zend

とすると現在使用可能なものが表示される。