ソースからクロスリファレンス

PHPのソースからクロスリファレンスを生成します。

ソースからクロスリファレンス

かの有名な言葉（？）に「ソースがドキュメントだ。バグも完全に記述されている」がある。ソースが汚い人のためにもドキュメントが必要なのだが、そう言う人に限ってドキュメントも見づらく殆ど見られなくなる場合が多い。綺麗なソースならドキュメントを見るまでもない場合もある。言いえて妙だ。

但し、大勢が同じクラス、オブジェクトを利用する場合は別だ。いちいちソースから当たっていられない。しかしそんな時だけドキュメントを作ると言うのも面倒だ…。

本日紹介するオープンソース・ソフトウェアはPHPXref、PHPのソースコードからクロスリファレンスを生成してくれるソフトウェアだ。

こう言ったツールでJavaDocやPHPDocのようなものも存在するが、こちらはAPIだけではなくドキュメント化可能だ。定義されている関数から、呼び出し元を一覧表示するといった使い方もできる。

全体像を知り得たプロジェクトなら良いだろうが、そうでない場合は便利だ。Pearのようなプロジェクト然り、xoops然りだろう。Perlで動作し、設定ファイルを書き換えるだけなので手軽に利用可能だ。

ソースコード表示で同じ変数をハイライトしてくれる仕組みもある。こう言う便利機能は嬉しい。使って損はないツールだ（ドキュメントも生成可能であるし）。