Wie erstellen Sie POD und nutzen pod2usage in perl?

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:

use Getopt::Long;
use Pod::Usage;

my( $opt_help, $opt_man, $opt_full, $opt_admins, $opt_choose, $opt_createdb, );

GetOptions(
    'help!'                 =>      \$opt_help,
    'man!'                  =>      \$opt_man,
    'full!'                 =>      \$opt_full,
    'admin|admins!'         =>      \$opt_admins,
    'choose|select|c=s'     =>      \$opt_choose,
    'createdb!'             =>      \$opt_createdb,
)
  or pod2usage( "Try '$0 --help' for more information." );

pod2usage( -verbose => 1 ) if $opt_help;
pod2usage( -verbose => 2 ) if $opt_man;

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 in GetOptions. Wir verwenden 'name' => \$opt_name hier. Dann fügen Sie diese:

pod2usage(-verbose => 99, -sections => "NAME") if $opt_name;

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.

InformationsquelleAutor Telemachus