作者: ねこ丸
日時: 2003/11/6(17:01)
  ねこ丸です。

Kenji Inoue さん writes:

>   普通のpodを見る限り、引数や戻り値の説明は1つのパラグラフで構成しちゃってるのが多いですね。
> あんまし構成を複雑にすると冗長過ぎるようです。だいたいは
> 
> =head1 DESCRIPTION
> 
> にまとめて書くとか、
> 
> =head1 METHODS
> 
> などを作ってその中に関数やメソッドを書くってのが多いような気がします。

  試してみたのですが、= から始まるコマンド行を連続して書けない(連続させ
るためには空行が必要)なので、構造を詰め込んで書くと素の pod がずいぶん
まぬけになってしまいますね。だからと言って普通に文章として書くのもなんだ
かイマイチな感じが。。。

変数  説明
変数  説明
変数  説明

  と、対応する感じで表示できると嬉しいんですよね。そのためには =item を
使う必要がある。HTML をそのまま書くという手もありますが、そうすると 
pod2text なんかで表示させたときに都合が悪い。
  うーむむむ。

  まー手元のたいがいの Perl スクリプトは小物なので悩む必要はないのですが、
ドキュメントを残したいと思うやつは「残す必要がある」ってことなので、きっ
ちり書ける方法を採ろうかなと思います。
  pod2html、なかなか便利ですね。これから重宝しそうです。
  おつきあいありがとうございます。

p.s.  マトリックス見た人居ます?
      初日はさすがに体力的に無理でした。。。

--
    ねこ丸