Wie erstellen Sie POD und nutzen pod2usage in perl?
Ich möchte einen POD für meine eigenen Befehl und zeigen Sie die syntax für die Verwendung pod2usage () - Funktion.
Kann mir jemand ein einfaches Beispiel?
Grüße,
Anandan
InformationsquelleAutor Anandan | 2009-08-05
Du musst angemeldet sein, um einen Kommentar abzugeben.
Neige ich dazu, dies zu tun mit Getopt::Long zusammen mit Pod::Usage. (Ich habe in dieser Gewohnheit, nach der Lektüre ein tutorial über die PerlMonks-Website, so hier ist der link dazu.) Es sieht etwas wie in diesem Beispiel:
Optionen andere als
$opt_man
und$opt_help
irrelevant sind, um Sie in diesem Beispiel. Ich Kopier einfach oben ein random script, das ich hier hatte.Danach, Sie müssen nur schreiben die POD. Hier ist ein guter link beschreibt die Grundlagen der POD selbst.
Bearbeiten: In Reaktion auf die OP ' s Frage in den Kommentaren, hier ist, wie Sie möglicherweise drucken Sie nur die
NAME
Abschnitt, wenn Sie übergeben eine entsprechende option. Fügen Sie zunächst eine weitere option, um den hash mit Optionen inGetOptions
. Wir verwenden'name' => \$opt_name
hier. Dann fügen Sie diese:Verbose level 99 Magie: es ermöglicht Ihnen, wählen einen oder mehrere Bereiche, die nur gedruckt werden. Finden Sie in der Dokumentation von
Pod::Usage
unter-sections
für mehr details. Beachten Sie, dass-sections
(der name) ist der plural auch wenn Sie nur einen Abschnitt.pod2usage(-Abschnitt=>'NAME'); Drucke die NAMEN + anderen Abschnitten. dies tut mir helfen
Ich fügte hinzu, eine Erklärung darüber, wie dies zu tun, in der Antwort selbst.
InformationsquelleAutor Telemachus
Gibt es viele gute Beispiele in der perlpod manpage. Pod2usage erklärt hier.
Agnew: ja, du hast Recht. Ich habe bearbeitet meine Antwort einen link zu pod2usage Erklärung und Beispiele.
InformationsquelleAutor ire_and_curses