PHPDocumentorを使ってAPIを作ってみる。

PHPDocumentor

pear install phpDocumentor


では最新バージョンがインストされない模様。

しかもこのバージョンはバグってる模様。

取り合えず最新版を落とす。

僕がコレを書いてる時の最新は1.3.0

ググって探して来て下さい。

で、旧バージョンを消してDLした最新版を解凍して同じディレクトリ名で置いてしまいます。

これで設置はOK。

ちなみにただ置くだけではうまく動かない模様。

pear install phpDocumentor
はやっとくとそれなりに意味があるようだ。

パスの解決とかしてくれる。

で、ドキュメントを自動で吐き出してくれるバッチファイルを作る。

phpdoc -d C:\apache\php5\PEAR\PhpDocumentor\module\ -t C:\apache\php5\PEAR\PhpDocumentor\api\

と、書いて「〜.bat」としておけばOK。

  • d 以降の部分は参照するソースの格納先の指定
  • t 以降は出来上がったAPIドキュメントの格納先

で、このままだと日本語のコメントは文字化けしてしまう。

原因はAPIのテンプレートにある。

"PHPのパス"\PEAR\PhpDocumentor\phpDocumentor\Converters\HTML\frames\templates\default\templates

にテンプレートがあるので改造する。

blank.tpl
header.tpl
index.tpl
top_frame.tpl

の

charset=iso-8859-1

を

charset=euc-jp

に、変える。

ついでに見た目も自分好みにしたかったらここを変えればOK。

その際はバックアップを取って置くとよいと思います。

参考URL：http://phpspot.net/php/pgphpDocumentor%82%BB%82%CC%82Q.html