perldoc / POD-不要在段落中添加多余的行

时间:2018-11-30 18:01:07

标签: perl documentation

我正在尝试编写一些POD文档,并使用perldoc来显示它。我的目标是使格式看起来像这样:

REQUIRED ARGUMENTS
    argument1
        Description of the first argument. 

    argmuent2
        Description of the second argument.            

“必需的参数”为粗体,“ argument1”和“ argument2”为斜体。

但是我无法弄清楚如何获得该特定的缩进。

我已经尝试过了:

=head1 REQUIRED ARGUMENTS

I<argument1>
Description of the first argument.

I<argument2>
Description of the second argument.

会产生以下结果(正确显示了粗体标题和斜体,但是不希望出现描述的后续部分):

REQUIRED ARGUMENTS
    argument1 Description of the first argument.

    argument2 Description of the second argument.

我已经尝试过:

=head1 REQUIRED ARGUMENTS

I<argument1>

Description of the first argument.

I<argument2>

Description of the second argument.

产生以下内容(同样,粗体和斜体字也不错,但现在参数和描述之间有多余的界线)

REQUIRED ARGUMENTS
    argument1

    Description of the first argument.

    argument2

    Description of the second argument.

除其他未成功之外,我还尝试了以下方法:

=head1 REQUIRED ARGUMENTS

I<argument1>

=over 4

Description of the first argument.

=back

具有以下结果:

REQUIRED ARGUMENTS
    argument1

        Description of the first argument.

1 个答案:

答案 0 :(得分:5)

使用项目作为参数:

=head1 REQUIRED ARGUMENTS

=over 4

=item I<argument1>

Description of the first argument.

=item I<argument2>

Description of the second argument.

=back

=cut