Perl POD-Dokumentation

Autor：Eve Cole Aktualisierungszeit：2024-12-24 16:24:01

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

POD ist eine einfache und benutzerfreundliche Auszeichnungssprache (Auszeichnungssprache).

Nutzungsregeln für POD-Dokumente:

Das POD-Dokument beginnt mit =head1 und endet mit =cut . Fügen Sie vor =head1 und nach =cut eine Leerzeile hinzu.

Perl ignoriert die Dokumentation in PODs. Beispiele sind wie folgt:

Beispiel

#!/usr/bin/perl drucken " Hallo, Welt n " = head1 Hallo, Welt Beispiel Dies ist ein einfaches Perl-Beispiel. =schneiden drucken „ Hallo, Codercto n “ ;

Wenn Sie das obige Programm ausführen, lautet das Ausgabeergebnis:

 Hallo WeltHallo, Codercto

Wir können auch „__END__“ oder „__DATA__“ verwenden, um den gesamten Inhalt nach der Zeile zu „auskommentieren“:

Beispiel

#!/usr/bin/perl drucken „ Hallo, Welt n “ ; while ( < DATA > ) { drucken $ _ ; __ENDE__ =head1 Hallo Weltbeispiel Dies ist ein einfaches Beispiel für Perl. print „Hallo, Codercton“;

Wenn Sie das obige Programm ausführen, lautet das Ausgabeergebnis:

 Hello, World=head1 Hello, World Beispiel Dies ist ein einfaches Perl-Beispiel. print „Hallo, Codercton“;

Das folgende Beispiel liest das POD-Dokument nicht:

Beispiel

#!/usr/bin/perl drucken „ Hallo Welt n “ __END__ =head1 Hallo Weltbeispiel Dies ist ein einfaches Beispiel für Perl. print „Hallo, Codercton“;

Wenn Sie das obige Programm ausführen, lautet das Ausgabeergebnis:

 Hallo Welt

Was ist POD?

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

Der Pod-Konverter kann Pod in viele Formate konvertieren, z. B. Text, HTML, Man usw.

Die Pod-Markup-Sprache enthält drei grundlegende Grundtypen: Normal, Text und Befehl.

Gewöhnliche Absätze : Sie können Formatierungscodes in gewöhnlichen Absätzen verwenden, z. B. Fettschrift, Kursivschrift oder Codestil, Unterstreichung usw.

Originalabsatz : Originalabsatz, der für Codeblöcke oder andere Teile verwendet wird, die keine Konverterverarbeitung erfordern und keine Neuanordnung des Absatzes erfordern.

Befehlsabsatz : Befehlsabsätze wirken sich auf das gesamte Dokument aus und werden normalerweise zum Festlegen von Titeln oder zum Markieren von Listen verwendet.

Alle Befehlsabsätze (die nur eine Zeile lang sind) beginnen mit „=", gefolgt von einem Bezeichner. Nachfolgender Text wird von diesem Befehl beeinflusst. Zu den mittlerweile weit verbreiteten Befehlen gehören:

 =pod (Startdokument)=Kopf1 Titeltext=Kopf2 Titeltext=Kopf3 Titeltext=Kopf4 Titeltext=über Anzahl der eingerückten Leerzeichen=Elementpräfix=zurück (Endliste)=Beginn des Dokumentformats=Ende Enddokumentformat=für Formattext =Kodierung Kodierungstyp=Schnitt (Ende des Dokuments)

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

Betrachten Sie die folgende POD-Instanz:

Beispiel

=begin html=encoding utf-8 =head1 Programmier-Tutorial =cut

Bei Verwendung von pod2html wird dieser Code aus dem Originaltext kopiert.

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

 $ pod2html test.pod > test.html

Öffnen Sie test.html im Browser. Der Linkteil ist der Index, wie unten gezeigt:

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

 =begin html=encoding utf-8<h1>Coder Tutorial</h1><p> www.codercto.com </p>=end html

Bei Verwendung von pod2html wird dieser Code aus dem Originaltext kopiert.

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

 $ pod2html test.pod > test.html

Öffnen Sie test.html im Browser. Der Linkteil ist der Index, wie unten gezeigt: