phpDocumentor を試す

phpDocumentor は、ソースコードからAPIドキュメントを作成するツール。javadoc みたいなもの。
http://www.phpdoc.org/

Ubuntu にはパッケージは用意されていないため、ファイルをダウンロードしてインストールすることにした。どうやら、圧縮ファイルを展開してパスを通せばすぐに使えるようだ。また、pear でインストールすることもできる。

実行例：

 $ phpdoc -o HTML:Smarty:PHP -t docs -d lib

この場合、lib ディレクトリ内のファイルを対象に、docs ディレクトリ以下に文書を作成する。

HTMLの文字化け

日本語が含まれている場合、生成された HTML が文字化けすることがある。
その場合は、テンプレートで charset が指定されている可能性がある。

[インストール先]/phpDocumentor/Converters/HTML/
から 以下のテンプレート内で文字コードを指定する場所を削除して対応した。

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

削除した行：

<?xml version="1.0" encoding="iso-8859-1" ?>

<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>