sample(3)      User Contributed Perl Documentation      sample(3)



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

SSYYNNOOPPSSIISS
        $sample->new();

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

        $sample->get_started();

        # perlmod2www.pl -source SOURCE -target TARGET


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

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

MMEETTHHOODDSS
       これ書いて実際のメソッドを head2 に回すと perldoc でかなり
       見やすくなります。Pdoc のドキュメントがこの形式を採用して
       いるので、ありがたく採用させていただきましょう。

       nneeww(( [[$$aarrgg]] ))

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

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

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

       ggeett__ssttaarrtteedd(( ppoodd ))

       必要なのは最低限の 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




perl v5.6.1                 2004-08-30                  sample(3)