インストールは、PEARを使用します。(それ以外の方法もあります)
pear install --alldeps phpDocumentor
PHPのインストールされたディレクトリをPHP_HOMEとして話を進めます。
pear installコマンドを実行すると、PHP_HOME/pear/PhpDocumentorが作成され、
(Windowsの場合)PHP_HOME/phpdoc.batというファイルが作成されます。
PHP_HOMEに環境変数が通っていれば、あとはphpdocコマンドを使用するだけです。
phpdoc -o HTML:Smarty:PHP -f PHPソースファイル1,PHPソースファイル2 -t ./document
-oオプションは出力フォーマットを指定しています。
フォーマット:テンプレートのディレクトリ
このオプションで使えるフォーマットの一覧は、「PHP_HOME/pear/data/PhpDocumentor/user/各iniファイル」で見ることができます。
-fオプションはパースするファイル名を指定しています。
ファイルごとではなくディレクトリごとまとめて指定したい場合は-dオプションを使用します。
-tオプションは生成したドキュメントを保存する場所を指定しています。
とりあえず最低限このくらい知っておけばいいかなと思います。
もっともーっと色々と機能があるようですが。
| オプション名 | 説明 |
|---|---|
| -o --output |
出力フォーマット(テンプレート)を指定する。 HTML:frames:earthli HTML:frames:default HTML:frames:l0l33t HTML:frames:phpdoc.de HTML:frames:phphtmllib HTML:frames:DOM/default HTML:frames:DOM/l0l33t HTML:frames:DOM/phpdoc.de HTML:frames:DOM/earthli HTML:frames:DOM/phphtmllib HTML:frames:phpedit HTML:Smarty:default HTML:Smarty:PHP HTML:Smarty:HandS が使える。(default.iniより抜粋) |
| -f --filename | パースしたいファイル名をカンマ区切りで指定する。 |
| -d --directory | パースしたいファイルの入ったディレクトリ名をカンマ区切りで指定する。 |
| -t --target | 結果を出力したいディレクトリを指定する。 |
| -ti --title |
出力したドキュメントのタイトルを指定する。 デフォルトは「Generated Documentation」で、各iniファイルのtitleで定義されている。 |