phpDocumentorのインストールからドキュメント生成まで行います。
phpDocumentor
phpDocumentor2 on GitHub
インストール環境はCentOS 6.6と、yumインストールしたPHPです。
インストール
インストール方法はいくつか提供されていますが、GitHubのREADMEではPEARがレコメンドされていたのでPEARでインストールします。
$ pear channel-discover pear.phpdoc.org
$ pear install phpdoc/phpDocumentor
プログラムからクラス図の生成を行う場合はGraphvizも併せてインストールしておきます。インストールしなくても問題ありません。
$ sudo yum install graphviz
ドキュメント生成
$ phpdoc run -t /path/to/docs -d /path/to/codes
オプション
とりあえずこれだけ押さえておけば不便しなさそう。
他にもまだまだあります。
--target, -t
ドキュメントの出力先
--directory, -d
ドキュメントを生成するソースコード
--title
ドキュメントページのタイトル
以下は、見つけたけれどまだ使っていないオプション
--visibility
ドキュメントに出力するアクセス権
未指定の場合、public, protected, privateすべてが出力されます。
publicだけ出力したい場合は指定する必要がありそうです。
--template
別のテンプレートを使う場合に指定します。
--encoding
ドキュメントに日本語が含まれている場合は指定したほうが良さそうな雰囲気がします。
--config, -c
設定をファイルで作成しておいて、実行時にはこのオプションで読み込んで実行できます。
備考
2014年11月23日現在の最新安定版バージョン2.8.1では、メソッドの1番目のパラメータに関するparamコメントを書いているにも関わらず、コメントがありません！という旨のエラーが出力されるという不具合があります。
Argument $[varname] is missing from the Docblock of [methodname] · Issue #1460 · phpDocumentor/phpDocumentor2
もうプログラムの修正は終わっているみたいです。
修正が反映されるまでは直前のバージョンを使うことにしました。2.8.0からの不具合なので、その前バージョンの2.7.0です。てなわけでインストールし直し。
$ pear uninstall phpdoc/phpDocumentor
$ pear install phpdoc/phpDocumentor-2.7.0
TODO
- メソッドのソースコードを表示するボタン？
</>が404エラーとなる。未確認