TSperl 発言

川合孝典です。

----- Original Message ----- 
From: "ねこ丸" <wtnabe@...>
To: <TSperl@...>
Sent: Thursday, November 06, 2003 12:06 PM
Subject: [TSperl:282] Re: スクリプトのドキュメント、どうやって書いてます？


>   ねこ丸です。
（中略）
>   とか、こんな感じになるのかなと思ったのですが。どんなもんでしょうか？
>   head1 や head2 はどういう用途に使えとか、ガイドラインみたいなのがある
> といいんですけどね。
Perlでモジュールを作成する場合には、

　h2xs -X -n Hoge

みたいにして、Makefile.PL、README、Changesも含めてまとめて
作ることが多いかと思います。
そうしたらHoge.pmには$VERSIONなんかの宣言と一緒に以下のような
PODが雛形として入ってきます。
#第3版の第26章 PODの一番最後　P763に含めるべきセクション
#としていくつか上げられていますね。
といっても関数のパラメータはこうしなはれってことは書いてません
けども。後は手本となるモジュールのPODのマネをするというのが
一番だと思います。

=ENDから下を引用=

__END__
# Below is stub documentation for your module. You better edit it!

=head1 NAME

Hoge - Perl extension for blah blah blah

=head1 SYNOPSIS

  use Hoge;
  blah blah blah

=head1 DESCRIPTION

Stub documentation for Hoge, created by h2xs. It looks like the
author of the extension was negligent enough to leave the stub
unedited.

Blah blah blah.

=head2 EXPORT

None by default.


=head1 AUTHOR

A. U. Thor, E<lt>a.u.thor@...<gt>

=head1 SEE ALSO

L<perl>.

=cut

===================================================
川合 孝典 (Hippo2000)
   DBI日本語メーリングリスト管理人、Kansai.pm所属
   kwitknr@... GCD00051@...
   http://member.nifty.ne.jp/hippo2000、http://www.hippo2000.info/
perldocの日本語情報ならperldocjp：翻訳してみませんか？
  http://perldocjp.sourceforge.jp/
===================================================