ダメプログラマーのお勉強

　多くのプログラマーはドキュメントを書くのを嫌います。継続的メンテナンスなんてもってのほかです。でも、プログラムソースにコメントを書くぐらいなら許容範囲になる場合もあります。
　また、ソースを変更したときにドキュメントだけ更新を忘れるという可能性も低くできます。

　そんなわけで、最近はプログラムソースのコメントとしてドキュメントを書くというやり方が主流になってきています。JavaDocの普及のおかげで、一般的な方法になったようで、多くの言語には既にそういうプログラムが用意されています。

　そんなわけで、早速インストール。見事なぐらい簡単です。
　まずは、ドキュメントを置くディレクトリを作ります。公開フォルダの下にドキュメントフォルダを作るなど、セキュリティの観点からダメな気がしますが、あくまでお勉強なのでドキュメントルート以下に置きます。
　pearコマンドでphpDocumentorをインストールします。インストールはこれだけ。
　phpdocコマンドでドキュメントを作ります。-tは出力先ディレクトリ、-dはドキュメントを作る対象のディレクトリ、-oは出力内容です。出力内容はoutput:converter:templatedirといった形式になる模様。色々ありますが、普通のHTMLならHTML:Smarty:PHPで問題なさそう。PDF出力もできるようですね。
HTML:frames:default
HTML:frames:l0l33t
HTML:frames:phpdoc.de
HTML:frames:phphtmllib
HTML:frames:earthli
HTML:frames:DOM/default
HTML:frames:DOM/l0l33t
HTML:frames:DOM/phpdoc.de,
HTML:frames:DOM/phphtmllib
HTML:frames:DOM/earthli
HTML:Smarty:default
HTML:Smarty:PHP
HTML:Smarty:HandS
PDF:default:default
CHM:default:default
XML:DocBook/peardoc2:default

　-dと-oは","区切りで複数指定できます。実行すれば、あっさりドキュメント完成です。先のDBConnectionクラスも問題なくドキュメント化されました。

mkdir /home/webmaster/www/doc/
pear install --alldeps phpdocumentor
phpdoc -t ./doc/ -d ./ -o HTML:Smarty:PHP