Perl-組み込みドキュメント

PerlモジュールおよびスクリプトにPod（Plain Old Text）ドキュメントを埋め込むことができます。以下は、Perlコードに埋め込まれたドキュメントを使用するルールです-

空の行でドキュメントを開始し、先頭に= * head1 コマンドを入力し、= * *cut *で終了します

Perlは、コードに入力したPodテキストを無視します。以下は、Perlコード内で埋め込みドキュメントを使用する簡単な例です-

#!/usr/bin/perl

print "Hello, World\n";

=head1 Hello, World Example
This example demonstrate very basic syntax of Perl.
=cut

print "Hello, Universe\n";

上記のコードが実行されると、次の結果が生成されます-

Hello, World
Hello, Universe

Podをファイルの最後に配置し、ENDまたはDATAカットマークを使用する場合、次のように最初のPodコマンドの前に空の行を配置します。 = * head1 、多くの翻訳者は= * *head1 *をPodブロックの開始として認識していません。

#!/usr/bin/perl

print "Hello, World\n";

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

__END__

=head1 Hello, World Example
This example demonstrate very basic syntax of Perl.
print "Hello, Universe\n";

上記のコードが実行されると、次の結果が生成されます-

Hello, World

=head1 Hello, World Example
This example demonstrate very basic syntax of Perl.
print "Hello, Universe\n";

DATA部分を読み取らずに同じコードのもう1つの例を見てみましょう-

#!/usr/bin/perl

print "Hello, World\n";

__END__

=head1 Hello, World Example
This example demonstrate very basic syntax of Perl.
print "Hello, Universe\n";

上記のコードが実行されると、次の結果が生成されます-

Hello, World

PODとは何ですか？

Podは、Perl、Perlプログラム、およびPerlモジュールのドキュメントを作成するために使用される、使いやすいマークアップ言語です。 Podをプレーンテキスト、HTML、マニュアルページなどのさまざまな形式に変換するためのさまざまなトランスレーターがあります。ポッドマークアップは、3種類の基本的な段落で構成されます-

通常の段落-太字、斜体、コードスタイル、ハイパーリンクなど、通常の段落で書式設定コードを使用できます。
逐語的な段落-逐語的な段落は通常、特別な解析や書式設定を必要とせず、折り返すべきではないコードブロックやその他のテキストを表示するために使用されます。
コマンド段落-コマンド段落は、通常、見出しまたはリストの一部として、テキスト全体を特別に扱うために使用されます。すべてのコマンドの段落は=で始まり、その後に識別子が続き、その後にコマンドが自由に使用できる任意のテキストが続きます。現在認識されているコマンドは-

=pod
=head1 Heading Text
=head2 Heading Text
=head3 Heading Text
=head4 Heading Text
=over indentlevel
=item stuff
=back
=begin format
=end format
=for format text...
=encoding type
=cut

PODの例

次のPODを考慮してください-

=head1 SYNOPSIS
Copyright 2005 [TUTORIALSOPOINT].
=cut

Linuxで利用可能な pod2html ユーティリティを使用して、上記のPODをHTMLに変換できるため、次の結果が生成されます-

著作権2005 [TUTORIALSOPOINT]。

次に、次の例を検討してください-

=head2 An Example List

=over 4
=item *This is a bulleted list.
=item* Here's another item.
=back
=begin html
<p>
Here's some embedded HTML.  In this block I can
include images, apply <span style="color: green">
styles</span>, or do anything else I can do with
HTML.  pod parsers that aren't outputting HTML will
completely ignore it.
</p>

=end html

pod2htmlを使用して上記のPODをHTMLに変換すると、次の結果が生成されます-

An Example List
   This is a bulleted list.
   Here's another item.
Here's some embedded HTML. In this block I can include images, apply
styles, or do anything else I can do with HTML. pod parsers that aren't
outputting HTML will completely ignore it.

Perl-embedded-documentation

Perl-組み込みドキュメント

PODとは何ですか？

PODの例

著作権2005 [TUTORIALSOPOINT]。

目次