如何在 Perl POD 中记录参数

Question

我有这个 POD：

=head1 My code

=head2 check

Checks something. 

Parameters:

=over 8

=item what to check.

=back

=cut

podchecker不抱怨。perldoc显示这个：

My code
  check
    Checks something.

    Parameters:

    what to check.

我希望“检查内容”行进一步缩进。

我需要如何更改我的 POD 以显示缩进的参数？有没有比=items更好的方法来做到这一点？

Answer 1

双方perldoc并pod2html忽略indentlevel。使用项目符号作为解决方法。请参阅下面的示例。

=head1 My code

=head2 check with no bullets or numbers

Checks something. 

Parameters:

=over

=item what to check A

=item what to check B

=back

=head2 check with bullets

Checks something. 

=over

=item * what to check A

=item * what to check B

=back

=head2 check with numbers

Checks something. 

=over

=item 1. what to check A

=item 2. what to check B

=back

=cut

运行perldoc /path/to/script.pl结果如下：

My code
   check with no bullets or numbers
       Checks something.

       Parameters:

       what to check A
       what to check B

   check with bullets
       Checks something.

       o   what to check A

       o   what to check B

   check with numbers
       Checks something.

       1. what to check A
       2. what to check B

参考：

"=over"的indentlevel选项表示缩进多远，通常以 em（其中一个 em 是文档基本字体中“M”的宽度）或大致相当的单位为单位；如果没有 indentlevel选项，则默认为 4。（有些格式化程序可能会忽略您提供的任何缩进级别。）

（来自perldoc perlpod，粗体我的）