Perl POD ドキュメント

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

PODは、シンプルで使いやすいマークアップ言語(マークアップ言語)です。

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

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

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

#!/usr/bin/perl

print "Hello, World\n";

=head1 Hello, World 实例
这是一个 Perl 的简单实例。
=cut

print "Hello, php\n";

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

Hello, World
Hello, php

"__END__" または "__DATA__" を使用して、次の行の後のすべてのコンテンツを "コメント" アウトすることもできます:

#!/usr/bin/perl

print "Hello, World\n";

while(<DATA>){
  print $_;
}

__END__

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

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

Hello, World

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

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

#!/usr/bin/perl

print "Hello, World\n";

__END__

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

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

Hello, World

POD とは?

Pod (Plain Old Documentation) は、Perl プログラムやモジュールでのドキュメント作成によく使用される、シンプルで使いやすいマークアップ言語 (マークアップ言語) です。

Pod のコンバーターは、Pod をテキスト、HTML、Man などのさまざまな形式に変換できます。

Pod マークアップ言語には、通常、オリジナル、コマンドという 3 つの基本的なタイプが含まれています。

通常の段落: 通常の段落では、太字、斜体、コードスタイル、下線などの書式設定コードを使用できます。
元の段落: 元の段落。コンバーター処理を必要とせず、段落の再配置を必要としないコードブロックまたはその他の部分に使用されます。
コマンド段落: コマンド段落はドキュメント全体に適用され、通常はタイトル設定またはリストタグに使用されます。
すべてのコマンド段落 (長さは 1 行のみ) は「=」で始まり、その後に識別子が続きます。後続のテキストはこのコマンドの影響を受けます。現在広く使用されているコマンドには
```
=pod (开始文档)
=head1 标题文本
=head2 标题文本
=head3 标题文本
=head4 标题文本
=over 缩进空格数量
=item 前缀
=back (结束列表)
=begin 文档格式
=end 结束文档格式
=for 格式文本
=encoding 编码类型
=cut (文档结束)
```

などがあります。 Perl では、pod2html **.pod >**.html を使用して HTML 形式でポッドドキュメントを生成できます。

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

=begin html
=encoding utf-8

=head1 php中文网

=cut

pod2html が使用される場合、このコードは元のテキストからコピーされます。

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

$ pod2html test.pod > test.html

test.html をブラウザで開きます。リンク部分がインデックスであり、次のように表示されます。

次の例では、HTML を直接書き込みます。 POD ドキュメント内:

=begin html
=encoding utf-8

<h1>php中文网</h1>
<p> www.php.cn </p>

=end html

pod2html は、このコードの元のテキストをコピーします。

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

$ pod2html test.pod > test.html

test.html をブラウザで開きます。以下に示すように、リンク部分がインデックスになります。