我怎样才能摆脱Perl's Pod的空行,这样就不会出现Pod :: Usage?

时间:2010-10-14 16:53:03

标签: perl documentation-generation pod

我有以下pod,我使用getopt :: long:

=head1 SYNOPSIS

foo [OPTION]... [URL]...

=head1 OPTIONS

=over 20

=item B<-h, --help>

Print a brief help message and exits.

=item B<-i, --input=FILE>

Reads from FILE

=back

=cut

当我提供-h时它会产生:

Usage:
    foo [OPTION]... [URL]...

Options:
    -h, --help          Print a brief help message and exits.

    -i, --input=FILE    Reads from FILE

我的问题是:如何删除-h和-i之间的空行?

1 个答案:

答案 0 :(得分:7)

Pod::Usage只需调用类似perldocText::Pod的Pod格式化程序即可从您的Pod生成使用消息。您编写的Pod代码将使用这些工具用几行空格式化。如果你不想要那些,写下不同的Pod。例如

=over 4

=item B<-h>                     Print a brief help message and exits.

=item B<-i>, B<--input=FILE>    Reads from FILE

=back

不幸的是,当转换为其他格式(如HTML)时,它看起来不太好,而且您正在失去选项及其描述的良好垂直对齐方式。但是,由于Pod::Usage实际上是用于命令行程序,因此优化终端上文本的可读性似乎是合理的,而不是在HTML或类似内容中看起来很好。