Perl POD-Dokumentation

Perl POD (Plain Old Dokumentation) in der Moduldokumentation oder Skript eingebunden werden.

POD ist eine einfache und leicht tagbasierten Sprache (markup language) zu verwenden.

POD Dokumentation mit Hilfe von Regeln:

POD Dokumentation beginnt mit= head1, = Schnittendeund vor= head1= abgeschnitten , nachdem eine Leerzeile hinzuzufügen.

Perl ignoriert die POD-Dokumentation. Beispiele sind wie folgt:

#!/usr/bin/perl

print "Hello, World\n";

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

print "Hello, w3big\n";

Das obige Programm, das Ausgabe ist:

Hello, World
Hello, w3big

Wir können auch "__END__" oder "__DATA__" nach dem Inhalt der Zeile verwenden, wo alle "Kommentare" aus:

#!/usr/bin/perl

print "Hello, World\n";

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

__END__

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

Das obige Programm, das Ausgabe ist:

Hello, World

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

Die folgenden Beispiele sind nicht POD Dokumentation zu lesen:

#!/usr/bin/perl

print "Hello, World\n";

__END__

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

Das obige Programm, das Ausgabe ist:

Hello, World

Was ist POD?

Pod (Plain Old Dokumentation), eine einfache und leicht ist Tag-basierte Sprache (Markup Language) zu verwenden, wird es oft in Perl-Programme und Module in das Dokument geschrieben verwendet.

Pod Pod Umwandlung in eine Vielzahl von Formaten konvertiert werden, wie Text, HTML, Mann viel und so weiter.

Pod-Markup besteht aus drei grundlegenden Grundtypen: Normal, Original, und Befehle.

• Normaler Absatz: Sie Formatierungscodes in normalen Absätzen verwenden können, wie fett, kursiv oder Codierung Stil unterstreichen.

• Original - Absatz:Textpassagen, für einen Teil des Codeblocks oder andere Wandler Verarbeitung nicht erforderlich ist, aber keinen Absatz Umlagerung erfordern.

• Ziffer Befehl: Befehl Ziffer Rolle im gesamten Dokument oder eine Liste der am häufigsten verwendet , um die Titel - Tags zu setzen.

  Alle Befehls Absätze (seine einzige Leitungslänge), um die "=" verwenden und dann eine Kennung. Nachfolgende Text wird von diesem Auftrag betroffen sein. Befehl ist jetzt weit verbreitet sind:

  =pod (开始文档)
  =head1 标题文本
  =head2 标题文本
  =head3 标题文本
  =head4 标题文本
  =over 缩进空格数量
  =item 前缀
  =back (结束列表)
  =begin 文档格式
  =end 结束文档格式
  =for 格式文本
  =encoding 编码类型
  =cut (文档结束)

In Perl können Sie pod2html verwenden **. Pod> **. Html ein HTML-Dokument pod-Format zu erzeugen.

POD Betrachten Sie die folgenden Beispiele:

=begin html
=encoding utf-8

=head1 本教程

=cut

Dieser Code wird die ursprüngliche Kopie, wenn pod2html sein.

Verwenden Sie pod2html Befehl ausführen zu wandeln es in HTML-Code:

$ pod2html test.pod > test.html 

Öffnen Sie den Browser test.html, Links Abschnitt für den Index ist unten dargestellt:

Die folgenden Beispiele werden direkt in der POD Dokumentation HTML geschrieben:

=begin html
=encoding utf-8

<h1>本教程</h1>
<p> www.w3big.com </p>

=end html

Dieser Code wird die ursprüngliche Kopie, wenn pod2html sein.

Verwenden Sie pod2html Befehl ausführen zu wandeln es in HTML-Code:

$ pod2html test.pod > test.html 

Öffnen Sie den Browser test.html, Links Abschnitt für den Index ist unten dargestellt: