PHPDocumentor

以前コメントにあったPHPDocumentorを早速ためしてみた。
PHPDocumentorはjavadocなどと同様にプログラムソースのコメントからプログラムのドキュメントを
作成するプログラムで、Pearにもある。プログラムと別にドキュメントを書かないでよい分楽できる。
実際に使ってみた結果、結構まともに表示されるが、デザインで気に食わないところもあるし、日本語も化ける。Webブラウザで文字コードを指定すれば読むことはできる。
その点はまだオプションでいろいろ改善できそう。まだ、詳しく見てないのでなんとも言えない。
しかし出来栄えはかなりよい。では使い方を

まずpearからインストールする。

# pear install PhpDocumentor

とすることで勝手にインストールしてくれる。便利なpear。
現在2003年9月20日現在のバージョンは1.2.2.1。
インストールが無事終わったら/usr/local/bin/phpdocが出来上がっていて
それが実行ファイル。しかし、実行しようとしてもbad interpreterといわれてしまうので
phpdocを開いて1行目を書き換えようとするが、正しいパスを指してる。
しかたないので、/usr/local/lib/php/PhpDocumentor/phpDocumentor/phpdoc.incを実行する。
何故か改行コードが間違ってる模様。nkf -Luで改行コードを直す。
/usr/local/binにパスを通して

$ php /usr/local/lib/php/PhpDocumentor/phpDocumentor/phpdoc.inc -h
$ phpdoc -h

でヘルプ表示。簡単な使い方は

$ php /usr/local/lib/php/PhpDocumentor/phpDocumentor/phpdoc.ind -d ソースディレクトリ -t html吐き出しディレクトリ
$ phpdoc -d source_directory -t target_directory

で、作成できる。詳しいことがわかり次第追加する。