PHPXref for winを使ってみる

すごい今さらなのですが、
サーバ内のドキュメントがメチャクチャいっぱいあったので、
相乗りサーバに負荷をかけないように、ローカルで、
PHPドキュメントがすっきりみえるように、ある「PHPXref」なるものを使ってみました。

phpxref-0.7.tar.gz: Linux/*nix version with UNIX style line endings.
phpxref-0.7.zip: Windows/DOS style line endings (requires a working version of Perl to be installed).
phpxref-0.7-win32.zip: Download this version if you're running Windows and don't already have Perl installed.
という3バージョンが出ているようですが、
perlが入っていなくて、すぐにできるwin版があったのでその設定を簡単にメモっておきます。

1.phpxrefをDLする
http://sourceforge.net/project/downloading.php?groupname=phpxref&filename=phpxref-0.7-win32.zip&use_mirror=nchc

2.phpxref.cfgを書き換える
2.5 SOURCEで指定された部分に構造を確認したいファイルを丸ごとおく。
document and settingsなどは途中で空白が入っているためうまく動かないため、
ベタにC:下におくのがベター。

3.SOURCE,OUTPITの部分を書き換える

• • • • • • • • • -

# The base directory containing all of your PHP code to be indexed
# This could just be a directory containing symlinks to the real directories
#SOURCE=C:\webserver\sites\www.myhost.com\htdocs
SOURCE=C:\samplesrc

# The directory in which you'd like the output to be written
#OUTPUT=C:\phpxref\output
OUTPUT=C:\samplesrcout

• • • • • • • • • -

4.phpxref.exeを実行する
5.動かない場合はコマンドプロンプトから実行し、エラーログを確認する。
(あやしい部分のディレクトリを空にしてみるとうまくいった！)
6.OUTPUTで指定したディレクトリに
navi.htmlが作成され
file:///C:/samplesrcout/nav.html が作成させれいればOK

本日紹介するオープンソース・ソフトウェアはPHPXref、PHPのソースコードからクロスリファレンスを生成してくれるソフトウェアだ。こう言ったツールでJavaDocやPHPDocのようなものも存在するが、こちらはAPIだけではなくドキュメント化可能だ。定義されている関数から、呼び出し元を一覧表示するといった使い方もできる。

■参考
ソースからクロスリファレンス - PHPXref:phpspot開発日誌
PHPXref - クロスリファレンスドキュメントの自動生成 - Do You PHP?

実際に使ったときのサンプル画面

サンプルリンク PHPSPOT開発日誌さん
PHPXref 0.6: Unnamed Project v0.00