PHP

トップ > チップス > PHP

phpDocumentor試用

かのJavadocのように、ソースコードの構造を自動解析してドキュメントを自動生成してくれるツールです。DocCommentと呼ばれる形式のコメントをコードの各部分に入れておけば、それを抽出して（読みやすいドキュメント形式になった）テンプレートに埋め込んでくれます。

/**
 * 以下の定数に関する説明。
 */
define('FOO','VALUE OF FOO');


CentOS6でのインストールはyumで一発でした。

# yum -y install php-pear-PhpDocumentor


生成のコマンドは以下のとおりです。-dの後ろが変換元、-tの後ろが変換先です。

$ phpdoc -d path/to/php1/,path/to/php2/ -t path/to/doc/ -o HTML:Smarty:PHP


色々試してみましたが、まず文字化けの問題がつきまといます（回避法はあるようですが）。それから、既存のライブラリに対して変換をしてみましたが、名前空間やクラスの使用が徹底されていないコードのリファレンスを作っても、やっぱり見辛い、です（これは適用されるライブラリの側の問題ですが…）。

参考URL

• タグ別一覧: [php]
• チップス一覧