PODドキュメント

back
perldoc で参照できるドキュメントをソースコードに埋め込む。
また、pod2html で html 形式に変換できる。

=pod_command

から

=cut

まで。
ソースコード中、何度もどこにでも記述できる。
基本的に、空行が区切り。


=headN strings
N は 1,2 で、見出し(レベル1,2)の文字列を指定。
HTML では <h1>, <h2> になる

=over N

N 文字分、インデントされる。
入れ子可能。その場合は、前のインデントに加算される
(HTML では無視される?)

=back

over のインデントを解除する。
入れ子の場合は一つ前のインデントのみ解除される

=item string

箇条書き。
HTML では <dl>,<dt>,<dd> の dt(Definition Term)要素 になる。
次の行に文章を書くと、dd(Definition Description)となる。

=cut

ドキュメントの終わり
これ以降はコードとして評価される。

ちなみに、__END__ 以降の POD ドキュメントも評価される。

back