Perl では、POD (Plain Old Documentation) ドキュメントをモジュールまたはスクリプトに埋め込むことができます。
POD は、シンプルで使いやすいマークアップ言語 (マークアップ言語) です。
POD ドキュメントの使用規則:
POD ドキュメントは=head1で始まり=cutで終わります。 =head1の前と=cutの後に空行を追加します。
Perl は POD 内のドキュメントを無視します。例は次のとおりです。
上記のプログラムを実行すると、出力結果は次のようになります。
Hello、WorldHello、コーデクト
「__END__」または「__DATA__」を使用して、次の行の後のすべてのコンテンツを「コメント化」することもできます。
上記のプログラムを実行すると、出力結果は次のようになります。
Hello, World=head1 Hello, World の例 これは簡単な Perl の例です。 print "こんにちは、Codercton";
次の例では、POD ドキュメントを読み取りません。
上記のプログラムを実行すると、出力結果は次のようになります。
こんにちは世界
Pod (Plain Old Documentation) は、Perl プログラムやモジュールでのドキュメント作成によく使用される、シンプルで使いやすいマークアップ言語 (マークアップ言語) です。
Pod コンバータは、Pod をテキスト、html、man などのさまざまな形式に変換できます。
Pod マークアップ言語には、通常、テキスト、コマンドという 3 つの基本的なタイプが含まれています。
通常の段落: 通常の段落では、太字、斜体、コード スタイル、下線などの書式設定コードを使用できます。
元の段落: 元の段落。コンバーター処理を必要とせず、段落の再配置を必要としないコード ブロックまたはその他の部分に使用されます。
コマンド段落: コマンド段落はドキュメント全体に作用し、通常はタイトル設定またはリストのマークアップに使用されます。
すべてのコマンド段落 (長さは 1 行のみ) は「=」で始まり、その後に識別子が続きます。 後続のテキストはこのコマンドの影響を受けます。現在広く使用されているコマンドには次のものがあります。
=pod (開始ドキュメント)=ヘッド 1 タイトル テキスト=ヘッド 2 タイトル テキスト=ヘッド 3 タイトル テキスト=ヘッド 4 タイトル テキスト=インデントされたスペースの数=項目プレフィックス=バック (終了リスト)=開始ドキュメント フォーマット=終了 終了ドキュメント フォーマット=フォーマット テキスト用=encoding エンコードタイプ=cut (文書の終わり)
Perl では、pod2html **.pod >**.html を使用して、ポッド ドキュメントを HTML 形式で生成できます。
次の POD インスタンスを考えてみましょう。
pod2html を使用する場合、このコードは元のテキストからコピーされます。
pod2html コマンドを使用して実行し、HTML コードに変換します。
$ pod2html テスト.pod > テスト.html
ブラウザで test.html を開くと、以下に示すように、リンク部分がインデックスになります。
次の例では、HTML を POD ドキュメントに直接書き込みます。
=begin html=encoding utf-8<h1>コーダー チュートリアル</h1><p> www.codercto.com </p>=end html
pod2html を使用する場合、このコードは元のテキストからコピーされます。
pod2html コマンドを使用して実行し、HTML コードに変換します。
$ pod2html テスト.pod > テスト.html
ブラウザで test.html を開くと、以下に示すように、リンク部分がインデックスになります。