xampp で phpDocumentor を使えるようにする

php のライブラリやアプリケーション・CMS などの API を理解するためにソースを追いかけるっというのは無駄なのでドキュメントを生成して、ドキュメントから読み解くのが正着。

php では phpDocumentor が主に使われています。

Zend Framework や Google app engine、WordPress など。

インストール手順・使い方をよく忘れるのでメモ（以下 Windows + xampp 環境

 

php に環境変数を通しておく

環境変数PATHに xamppインストールフォルダ/php を通しておくと便利なので通しておく。

 

pear コマンドの確認

pear が使えるか確認、pear バージョンが出れば使える。

pear version

 

インストールの前に、xampp に古い phpDocumentor 1.4.4 が入っていたので削除。

pear uninstall phpDocumentor

 

ついでに pear の更新。

pear upgrade-all

 

phpDocumentor のインストール

phpDocumentor 公式サイトの手順に従って進める。 インストールは pear のコマンドから。

pear channel-discover pear.phpdoc.org
pear install phpdoc/phpDocumentor

 

phpDocumentor のインストール完了。

phpdoc 起動のための環境変数を設定。

PHPBIN と PHP_PEAR_BIN_DIR を通す。

 

もしくは、xamppインストールフォルダ/php の phpDocumentor 起動バッチを修正。

最終行をコピーして書き変え・コメントアウト

@echo off
if "%PHPBIN%" == "" set PHPBIN=php.exe
if not exist "%PHPBIN%" if "%PHP_PEAR_PHP_BIN%" neq "" goto USE_PEAR_PATH
GOTO RUN
:USE_PEAR_PATH
set PHPBIN=%PHP_PEAR_PHP_BIN%
:RUN
rem "%PHPBIN%" "%PHP_PEAR_BIN_DIR%\phpdoc.php" %* ここをコピーして rem でコメントアウト
"%PHPBIN%" "xamppディレクトリのパス\php\phpdoc.php" %*

 

ここまでやれば phpdoc コマンドが使えます。

 

phpDocumentor でドキュメントを出力する

コマンドの使い方は phpdoc -h でヘルプが見られる。

 

基本的には、

phpdoc -d {ドキュメントを作りたいパス} -t [出力先]

でオッケー。

–title “タイトル” とか使うと、ドキュメントのタイトルの指定ができたりする。

 

 

phpdoc コマンドでドキュメントを作るも、

「Unable to find the ‘dot’ command of the GraphViz package. Is GraphViz correctly installed and present in your path?」つまり、GraphViz が入ってないし PATH が通ってないよ！

と怒られるのでドキュメントのチャート生成に必要な graphviz を入れる。

Windoes 用をインストールして、GraphViz インストールディレクトリの bin フォルダに環境変数PATH を通す。

これでようやく問題なく出力できるように。

WordPress のプラグイン、Jetpack の API Document 生成を試す。

 

できた。

 

ﾎﾎまとめ

完全に自分のためのメモ。

よく忘れることは書いておくとあとあと自分で思い出せるのでよし。

ついでに作成した Jetpack のドキュメントをサーバーにアップしておいたんで、必要な人は見るといいかも。