phpDocumentorを導入してみた

May 27, 2011,
tags: php phpdocumentor


このエントリーをはてなブックマークに追加

ほんと今更なにいっているのですか?ってぐらいの話題ですが、APIドキュメントの管理とか大変なんでphpDocumentorを導入してみました。
ソースコードのコメントはある程度統一されているので問題なく生成できました。
導入の記録を残しておきます

インストールする
sudo pear install --alldeps phpdocumentor

たったこれだけでインストールしてくれます。

生成する

phpdoc -t ./output_dir/ -d ~/codes/ -o HTML:frames:earthli

これだけでドキュメントが生成されます。
あとは生成したディレクトリをapacheのドキュメントルートにしておけばAPIドキュメントが見れる訳です。

文字化け対策

2011年5月27日時点での段階での対処法はどうやらapacheのデフォルトの文字コードを指定してあげればいいです。
http.confとかバーチャルホストの設定のところに以下のように書いてあげれば文字化けしないです。

AddDefaultCharset UTF-8

comments powered by Disqus