Perl-POD-Dokumentation

In Perl können POD-Dokumente (Plain Old Documentation) in Module oder Skripte eingebettet werden.

POD ist eine einfache und benutzerfreundliche Auszeichnungssprache.

Nutzungsregeln für POD-Dokumente:

POD-Dokumente beginnen mit=head1starten,=cutenden,=head1vor und=cutfügen Sie danach eine Leerzeile ein.

Perl ignoriert die Dokumentation in POD. Beispiel folgt:

Beispiel

#!/usr/bin/perl print "Hello, World\n"; =head1Hallo-Welt-Beispiel Dies ist ein einfaches Perl-Beispiel.=cut print "Hello, Example\n";

Das Ausführen des obigen Programms erzeugt die folgende Ausgabe:

Hello, World
Hello, Example

Wir können auch "__END__" oder "__DATA__" verwenden, um alle Inhalte nach der Zeile, in der sie erscheinen, "auszukommentieren":

Beispiel

#!/usr/bin/perl print "Hello, World\n"; while(<DATA>){ print $_; } __END__ =head1Hallo-Welt-Beispiel Dies ist ein einfaches Perl-Beispiel. print "Hello, Example\n";

Das Ausführen des obigen Programms erzeugt die folgende Ausgabe:

Hello, World

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

Das folgende Beispiel liest keine POD-Dokumentation:

Beispiel

#!/usr/bin/perl print "Hello, World\n"; __END__ =head1Hallo-Welt-Beispiel Dies ist ein einfaches Perl-Beispiel. print "Hello, Example\n";

Das Ausführen des obigen Programms erzeugt die folgende Ausgabe:

Hello, World

Was ist POD?

Pod (Plain Old Documentation) ist eine einfache und benutzerfreundliche Auszeichnungssprache, die häufig zum Schreiben von Dokumentation in Perl-Programmen und -Modulen verwendet wird.

Pod-Konverter können Pod in viele Formate umwandeln, wie z. B. Text, HTML, man und viele mehr.

Die Pod-Auszeichnungssprache enthält drei grundlegende Typen: gewöhnliche, wörtliche und Befehlsabsätze.

Gewöhnlicher Absatz: In gewöhnlichen Absätzen können Sie Formatierungscodes verwenden, wie fett, kursiv oder Code-Stil, Unterstreichung usw.
Wörtlicher Absatz: Wörtliche Absätze werden für Codeblöcke oder andere Teile verwendet, die keine Konverterverarbeitung benötigen und keinen Absatz-Neuumbruch erfordern.
Befehlsabsatz: Befehlsabsätze wirken sich auf das gesamte Dokument aus und werden normalerweise für Überschriftseinstellungen oder Listenmarkierungen verwendet.
Alle Befehlsabsätze (sie sind nur eine Zeile lang) beginnen mit "=" gefolgt von einer Kennung. Der folgende Text wird von diesem Befehl beeinflusst. Zu den derzeit weit verbreiteten Befehlen gehören
```
=pod (开始文档)
=head1 标题文本
=head2 标题文本
=head3 标题文本
=head4 标题文本
=over 缩进空格数量
=item 前缀
=back (结束列表)
=begin 文档格式
=end 结束文档格式
=for 格式文本
=encoding 编码类型
=cut (文档结束)
```

In Perl können Sie pod2html **.pod >**.html verwenden, um POD-Dokumente im HTML-Format zu erzeugen.

Betrachten Sie das folgende POD-Beispiel:

Beispiel

=beginhtml =encoding utf-8 =head1 Rookie Tutorial=cut

pod2html kopiert diesen Code wörtlich.

Verwenden Sie den Befehl pod2html, um ihn auszuführen und in HTML-Code umzuwandeln:

$ pod2html test.pod > test.html

Öffnen Sie test.html in einem Browser; der Linkbereich ist der Index und wird wie folgt angezeigt:

Das folgende Beispiel schreibt HTML direkt in ein POD-Dokument:

=begin html
=encoding utf-8

<h1>Example</h1>
<p> www.example.com </p>

=end html

pod2html kopiert diesen Code wörtlich.

Verwenden Sie den Befehl pod2html, um ihn auszuführen und in HTML-Code umzuwandeln:

$ pod2html test.pod > test.html

Öffnen Sie test.html in einem Browser; der Linkbereich ist der Index und wird wie folgt angezeigt:

Andere Erweiterungen