ねこ丸です。
# YukiWiki が 2.1 に向かってますね。今日知りました。
References: <200312161254.hBGCsTYh026802@...>
dune <FZH01112@...> さん writes
In 「[TSperl:298] Re: Pdoc 発見」
> ダウンロードしてみたけど使い方がさっぱりわからん。
> このモジュールを使って自分でツールを作れってことなのでしょう
> か(ぎゃふん)。
実はまだ試してません(^^;
とりあえず POD でのコメントはガシガシ埋め込んでます。
PHPDocumentor みたいなものかなと想像はしてるんですけどね。
# 実は POD に対応してなかったりして。。。
> ということで、スクリプトやソースを理解するための簡単なインラ
> インコメント以上の、DOXYGEN や POD に渡してドキュメントを作
> るためのコメントを入れるのって苦痛ではないですか?
僕の場合はどうせコメント書くなら可能な限り再利用できた方がいいなぁ、と
いうことなんですね。pod2html で吐き出した HTML を眺めるとけっこう満足し
ますよ(^^) head1 とか head2 で書いたコメントは自動的に TOC が作られるん
で、そこそこでかいファイルでも見通しがいいんですよ。(これを見るのが楽し
くて書いている感じ。)
書いてるときはやっぱちょっとまどろっこしい感じはします。でも自分のため
だと思ってるんで、苦痛ってことはないですね。
まーそんなに長大なドキュメントを POD で書いているわけじゃないんですが。
せいぜい関数の説明止まり。全体についてのコメントは、、、えーとまだ書いて
ませんけど(^^;、その辺は、配布するモジュールじゃないし、自由にやろうかと。
本当に長いドキュメントになるなら Wiki で書いちゃうと思います。適当なとこ
ろで分割できるし、修正するときにコードを気にする必要ないし。(あとでマー
ジするかもしれませんが。)
> DOXYGEN は比較的コーディング作業と相性が良いと思いますが、
> Perl の POD の場合は書く気になりませんです(自分向けにインラ
> インで簡単なコメントを書くのは好きですけど)。
doxygen は聞いたことがある程度で使ったことはないので分かんないですね。
でもこういう便利なツールは使わなきゃ損だと思うんで(特にたくさん書くな
らなおさら)、機会があったら挑戦したいですね。
--
ねこ丸