今回はphpのdocument生成ツールについて。
phpdocument
インストール
事前にGraphVizをインストールしていないと下記のようなエラーがでることがあります。
|
1 |
Unable to find the `dot` command of the GraphViz package. Is GraphViz correctly installed and present in your path? |
yumで入れられますので、まずはこのライブラリをインストールしましょう。
|
1 |
yum install -y graphviz graphviz-gd |
phpdocument自体はcomposerでインストールしてあげましょう。
|
1 2 3 |
"require":{ "phpdocumentor/phpdocumentor": "2.*", } |
ちなみに、composerを使わない場合にはpearで下記のようにインストールできます。
|
1 2 |
pear channel-discover pear.phpdoc.org pear install phpdoc/phpDocumentor |
使い方
あとは下記コマンドで自動的にドキュメントが生成されます。
|
1 2 3 4 |
./vendor/bin/phpdocument -d ./src/ (←ここにプログラムのディレクトリを書きます。) -t ./docs/ (←ここに出力したいドキュメントのディレクトリを書きます。あらかじめ作っておきましょう。) #複数のディレクトリを対象にしたいときはカンマでつなぎます。気を付けるべき点としてはスペースなしでつなぐこと。スペースあるとエラーになります。 ./vendor/bin/phpdocument -d ./src1/,./src2/ -t ./docs/ |
参考リンク
phpDocumentorを試してみた
phpDocumentor でドキュメント自動生成してみた
phpDocumentorをインストールしてドキュメント生成
phpDocumentorを利用してみるメモ
