Wie füge ich mehrere PODs zum Ende meines Perl-Skript?
-
13-10-2019 - |
Frage
Ich war mit einem Tutorial Arbeit gefunden in der Perl-Dokumentation über die Verwendung Getopt :: Long in einem Skript. Dort zeigt es, wie Dokumentation hinzufügen mit Pod :: Usage eher dann alles eingeben zu müssen aus einem Unterprogramm oder so etwas. Wie auch immer im Beispiel haben sie dies;
GetOptions('help|?' => \$help, 'b|backup' => \&backup, d|discover => \&discover, man => \$man) or pod2usage(2);
pod2usage(1) if $help;
pod2usage(-exitstatus => 0, -verbose => 2) if $man;
Ich habe einige meiner eigenen Argumente.
ich, wie mit dem ersten Abschnitt der Dokumentation zu entnehmen. Aber wie kann ich mit dem zweiten Abschnitt beziehen, wie durch pod2usage(2)
angegeben?
Als ich füge Sie einen neuen Abschnitt nach dem =cut
am Ende des Abschnitts 1, wenn ich versuche, es zu haben, zeigen Sie es mich mit einem Befehl erfüllt bin prompt, wie es in ging und dann, ohne Show des Abschnitt. Bin ich etwas falsch zu machen?
Lösung
Sie brauchen keine "multiple PODs".
pod2usage
, wenn du als genannt, zum Beispiel pod2usage(1)
, hier die 1 für den Exit-Status und die Ausführlichkeit als 1 angedeutet, so dass er die SYNOPSIS
gedruckt werden, und jegliche Abschnitte mit dem Titel OPTIONS
, ARGUMENTS
oder OPTIONS AND ARGUMENTS
Wenn sie als pod2usage(-exitval => 0, -verbose => 2)
genannt, wird es die Gesamtheit des POD, in Ihrem Textpager (identisch zu dem, was perldoc yourscriptname.pl
tun würde) drucken und Ausgang mit 0
. (Beachten sie die -exitval
und nicht -exitstatus
).
Es ist in der Pod::Usage
Dokumentation gut beschrieben rel="nofollow"> und funktioniert genauso wie beschrieben.
Sie können den optionalen Parameter -sections
finden nützlich pod2usage
für das, was Sie beschrieben haben, mit -verbose => 1
kombiniert, wählen, was Sie anzeigen möchten.