pdoc

私は「あるプログラムにおいて最新の仕様書は？」と聞かれたら間違いなくソースファイルと答えます。だからソースファイルから仕様書を作ってくれる、Javadoc や http://www.stack.nl/~dimitri/doxygen/ は開発にはなくてはならない存在です。JavaおよびC++を使ったアプリケーションを納品するときにそれぞれのツールを使って出力したHTMLをそのまま出したこともあります（一応簡単な仕様書は作りましたが）。

Perlでは Perldoc というプログラムがありますが、はっきり言ってこれはmanのPerl版で、自作モジュールには役に立ちません。そこで見つけたのが pdoc です。これはまんま Javadoc のように使えて、Javadoc のように出力してくれます。Indexが作成されないのが、Javadoc や Doxygen より弱いところだと思いますが、構文も綺麗に色分けしてくれるし申し分ありません（あとuse baseをキーワードにして継承ツリーや関数のオーバーライド等の情報もあれば最強なのですが）。

Perlモジュールを使って開発している人たちにはぜひ使ってほしいツールです。

主な使いかた

hogeに対象のソースファイルがあり、perldocにHTMLファイルを生成する場合、次のようにタイプする。

mkdir perldoc
perlmod2www.pl -source ./hoge -target ./perldoc