sample

sample

sample - そりゃあ サンプルですもの、意味なんかありませんよ。

 $sample->new();

 # perl Makefile.PL
 # make
 # make install
 # make がない？ どなたかどうやって使い始めるのか確かめてください :-)

 $sample->get_started();

 # perlmod2www.pl -source SOURCE -target TARGET

これは Pdoc 及び perldoc の出力を確かめるためのダミーの perl module で
す。間違って use したりしないでください :-)

まぁそれ以前にこのモジュールは「好奇心」を use しているのでコンパイル
が通りませんけど。

Methods description

必要なのは最低限の pod の書き方と Pdoc モジュールと perlmod2www.pl だけ。

 =pod

 この間はスクリプトとして解釈されません

 =cut

 =pod

 =head1 見出しレベル1

 =head2 見出しレベル2

 =cut

 perl perlmod2www.pl -source SOURCE -target TARGET

 perldoc - plain old documentation
 http://www.kt.rim.or.jp/%7ekbk/perl5.005/perlpod.html

 Perlドキュメントの読み方
 http://member.nifty.ne.jp/hippo2000/perltips/podread.htm

ここにね、説明を書いていくわけですよ。

new() だと bold にならないんですけど、new( ) や new( $arg ) と書くと 
perldoc で bold になるので、Pdoc でも perldoc も見やすいドキュメントは
両立できそうです。

ただし、Pdoc では自動的に改行しないので、だらだらとコメントを書き連ね
ていくとブラウザで横スクロールバーが出てうっとぉしいです。pod を書いて
いる段階で、エディタ上で適当に改行を入れてやりましょう。CSS 使いの人は 
CSS でなんとかするって手もあると思います。

Methods code

} ## End of get_started

} ## End of new()

General documentation