Perl POD ドキュメント

PerlではモジュールやスクリプトにPOD（Plain Old Documentation）ドキュメントを埋め込むことができます。

PODはシンプルで使いやすいマークアップ言語（マーク付け言語）です。

PODドキュメントの使用規則：

PODドキュメントは=head1で始まり、=cutで終わります。=head1前と=cut後に空行を追加します。

PerlはPOD内のドキュメントを無視します。例は次のとおりです：

例

#!/usr/bin/perl print "Hello, World\n"; =head1Hello, World の例これはPerlの簡単な例です。=cut print "Hello, サンプル\n";

上記のプログラムを実行すると、出力結果は次のようになります：

Hello, World
Hello, サンプル

また、"__END__" または "__DATA__" を使用して、その行以降の内容をすべて「コメントアウト」することもできます：

#!/usr/bin/perl print "Hello, World\n"; while(<DATA>){ print $_; } __END__ =head1Hello, World の例これはPerlの簡単な例です。 print "Hello, サンプル\n";

上記のプログラムを実行すると、出力結果は次のようになります：

Hello, World

=head1 Hello, World 实例
这是一个 Perl 的简单实例。
print "Hello, サンプル\n";

次の例はPODドキュメントを読み取りません：

#!/usr/bin/perl print "Hello, World\n"; __END__ =head1Hello, World の例これはPerlの簡単な例です。 print "Hello, サンプル\n";

上記のプログラムを実行すると、出力結果は次のようになります：

Hello, World

Pod（Plain Old Documentation）は、シンプルで使いやすいマークアップ言語（マーク付け言語）であり、Perlプログラムやモジュールにドキュメントを書くためによく使用されます。

Podの変換器は、Podをtext、html、manなど多くの形式に変換できます。

Podマークアップ言語には、普通、原文、コマンドの3つの基本タイプがあります。

普通段落: 普通段落では、太字、斜体、コードスタイル、下線などの書式コードを使用できます。
原文段落: 原文段落は、コードブロックや変換器による処理が不要な部分に使用され、段落のリフローも必要ありません。
コマンド段落: コマンド段落はドキュメント全体に作用し、通常は見出しの設定やリストのマークに使用されます。
すべてのコマンド段落（1行のみ）は "=" で始まり、その後に識別子が続きます。後続のテキストはこのコマンドの影響を受けます。現在広く使用されているコマンドには以下のものがあります。
```
=pod (开始文档)
=head1 标题文本
=head2 标题文本
=head3 标题文本
=head4 标题文本
=over 缩进空格数量
=item 前缀
=back (结束列表)
=begin 文档格式
=end 结束文档格式
=for 格式文本
=encoding 编码类型
=cut (文档结束)
```

Perlでは、pod2html **.pod >**.html を使用してHTML形式のPODドキュメントを生成できます。

次のPODの例を考えてみましょう：

=beginhtml =encoding utf-8 =head1 サンプル=cut

pod2htmlの際にこのコードは原文のままコピーされます。

pod2html コマンドを実行して、HTMLコードに変換します：

$ pod2html test.pod > test.html

ブラウザで test.html を開くと、リンク部分がインデックスとして以下のように表示されます：

次の例では、PODドキュメントに直接HTMLを記述します：

=begin html
=encoding utf-8

<h1>サンプル</h1>
<p> www.example.com </p>

=end html

pod2htmlの際にこのコードは原文のままコピーされます。

pod2html コマンドを実行して、HTMLコードに変換します：

$ pod2html test.pod > test.html

ブラウザで test.html を開くと、リンク部分がインデックスとして以下のように表示されます：

その他の拡張