perl - 向脚本添加帮助命令

Question

是否有向脚本添加帮助功能的标准方法？最简单的方法可能是接受一个参数并打印一些文本，如果它是“-help”或其他东西。有没有人有任何关于如何做到这一点的例子？

谢谢!

Answer 1

考虑 Getopt::Long加Pod::Usage .我编写 CLI 工具的常用模式:

#!/usr/bin/env perl
# ABSTRACT: Short tool description
# PODNAME: toolname
use autodie;
use strict;
use utf8;
use warnings qw(all);

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

# VERSION

=head1 SYNOPSIS

    toolname [options] files

=head1 DESCRIPTION

...

=cut

GetOptions(
    q(help)             => \my $help,
    q(verbose)          => \my $verbose,
) or pod2usage(q(-verbose) => 1);
pod2usage(q(-verbose) => 1) if $help;

# Actual code below