PerlのPODドキュメンテーション
PerlはモジュールのドキュメントまたはスクリプトでPOD(プレーン旧ドキュメント)埋め込むことができます。
PODは、シンプルで使いやすいタグベースの言語(マークアップ言語)です。
ルールを使用してPODのマニュアル:
PODのマニュアルは=HEAD1、=切り口で始まり、= HEAD1=の前に空白行を追加した後にカット。
PerlはPODドキュメントを無視します。 例としては、次のとおりです:
#!/usr/bin/perl print "Hello, World\n"; =head1 Hello, World 实例 这是一个 Perl 的简单实例。 =cut print "Hello, w3big\n";
上記のプログラムは、出力は次のようになります。
Hello, World Hello, w3big
また、すべての "コメント"アウト行の内容の後に「__END__」または「__DATA__」を使用することができます。
#!/usr/bin/perl print "Hello, World\n"; while(<DATA>){ print $_; } __END__ =head1 Hello, World 实例 这是一个 Perl 的简单实例。 print "Hello, w3big\n";
上記のプログラムは、出力は次のようになります。
Hello, World =head1 Hello, World 实例 这是一个 Perl 的简单实例。 print "Hello, w3big\n";
次の例では、PODのマニュアルを読んでされていません。
#!/usr/bin/perl print "Hello, World\n"; __END__ =head1 Hello, World 实例 这是一个 Perl 的简单实例。 print "Hello, w3big\n";
上記のプログラムは、出力は次のようになります。
Hello, World
PODとは何ですか?
ポッド(プレーン旧ドキュメント)、(マークアップ言語)シンプルで使いやすいタグベースの言語であり、それは多くの場合、文書に書かれたPerlプログラムとモジュールで使用されています。
ポッドポッド変換は、そのようなので、上のテキスト、HTML、多くの人と同様に、様々なフォーマットに変換することができます。
ノーマル、オリジナル、およびコマンド:ポッドのマークアップは、3つの基本的な基本的なタイプで構成されています。
通常の段落:あなたは下線、太字、斜体、またはコーディングスタイルとして、通常の段落に書式コードを使用することができます。
オリジナルの段落:テキストの一部、コードブロックの一部または他のコンバータの処理のためには必須ではありませんが、段落の並べ替えを必要としません。
段落コマンド:文書全体またはタイトルタグを設定するために使用される一般的なリストのコマンド段落の役割。
その後、「=」とを使用して、すべてのコマンド段落(彼の唯一の行の長さが)識別子です。 後続のテキストは、この順序によって影響を受けることになります。 コマンドは、現在広く使用されて含まれます
=pod (开始文档) =head1 标题文本 =head2 标题文本 =head3 标题文本 =head4 标题文本 =over 缩进空格数量 =item 前缀 =back (结束列表) =begin 文档格式 =end 结束文档格式 =for 格式文本 =encoding 编码类型 =cut (文档结束)
Perlでは、あなたは** pod2htmlを使用することができます。ポッド> **。htmlのhtml文書ポッド形式を生成します。
PODは、次の例を考えてみます。
=begin html =encoding utf-8 =head1 本教程 =cut
時pod2htmlこのコードは、元のコピーとなります。
HTMLコードに変換するためのコマンドを実行しpod2html使用します。
$ pod2html test.pod > test.html
ブラウザのtest.htmlというを開き、インデックスのセクションをリンクし、次のようになります。
以下の実施例はPODドキュメントのHTMLに直接書き込まれます。
=begin html =encoding utf-8 <h1>本教程</h1> <p> www.w3big.com </p> =end html
時pod2htmlこのコードは、元のコピーとなります。
HTMLコードに変換するためのコマンドを実行しpod2html使用します。
$ pod2html test.pod > test.html
ブラウザのtest.htmlというを開き、インデックスのセクションをリンクし、次のようになります。