<更新記録>
2008年 6月 17日
執筆

姉妹サイトから検索 Web検索

SWT - JavaでGUIプログラミング
きままにインデックス
JavaScriptノート
ゴルフ道具研究所

phpDocumentor 導入

ダウンロードとインストール

インストールは、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オプションは生成したドキュメントを保存する場所を指定しています。

とりあえず最低限このくらい知っておけばいいかなと思います。
もっともーっと色々と機能があるようですが。

主なオプション


Powered by VeryEasyCMS