Usoinfo blog

PHPのソースコードからドキュメントを生成したい。Javaにはjavadocがあるように、PHPにもそのようなものがある。というわけで、PHPのドキュメンテーションツール、phpDocumentor version2( http://phpdoc.org/ )を使用する。
まず、PHPでXSLが有効になっていないと使用できない。phpコマンドで調べる。

% php -r "phpinfo();" | grep XSL
XSL => enabled
EXSLT => enabled

enabledになっていない時は、libxsltをインストールして、--with-xsl を付けてPHPをビルドし直すなどする。CentOSなら、libxsltはyumでインストールできる。

phpDocumenterはpearからインストールする。また、実行にgraphvizが必要なので、これもインストール。

# pear channel-discover pear.phpdoc.org
# pear install phpdoc/phpDocumentor
# yum install graphviz

インストールできたら、コマンドを叩くだけ。

% phpdoc -d src -t docs \
 --extensions php,phps --encoding EUC-JP \
 --ignore-symlinks --title "MyPHPAPIDocument"
 --template zend

-d にソースファイルのあるディレクトリ、-t にドキュメントを生成するディレクトリを指定。--extensions は、解析するソースファイルの拡張子を設定し、ソースがUTF-8以外の文字コードで書かれていれば --encoding を指定。テンプレートの種類を変えたければ --template で指定。
生成ができれば、出力されたディレクトリのindex.htmlをブラウザで開けばOK。Javadoc風のコメントからドキュメントが生成されているはずだ。