Question

我正在以POD格式编写perl文档我的问题是，我希望有一个名为*

的项目标签

我尝试了=item *，=item S<*>，=item Z<>*和=item E<42>

所有方法都被解释为子弹，但我希望将星号解释为普通文本任何想法，如何在不添加更多文本的情况下解决此问题，例如=item "*"？

我不确定，如果这有用，但这是一个小例子（我放弃了空行）：

=pod
=head1 HEAD
=over 4
=item a
A
=item *
B
=item c
C
=back
=cut

在使用pod2text，pod2html等之前，我使用 podchecker 来检查我的文档。它说=item type mismatch ('definition' vs. 'bullet')
我没有在第一时间说过这个，因为我认为每个转换器都依赖于podchecker的解释

Answer 1

如果你显示你正在寻找的确切输出和你得到的输出，这将有所帮助。

我可以让星号显示在perldoc的输出中，只要我将其作为第二个=item：

=head1 OPTIONS

=over 5

=item help

Help me!

=item *

Asterisk

=back

=cut

以下是我从perldoc获得的输出：

OPTIONS
       help Help me!

       *    Asterisk

以下是perlpod的相关引言：

也许最重要的是，保持项目的一致性：要么使用   对所有人来说，“=项目*”，以生产子弹;或使用“=第1项”，   “=第2项”等，以编制编号清单;或使用“= item foo”，   “=项目栏”等等 - 即看起来像子弹或东西的东西   号。

如果您从子弹或数字开始，请坚持使用它们作为格式化程序   使用第一个“= item”类型来决定如何格式化列表。

另请参阅：Avoid inconsistent POD =over =item indentation

Answer 2

好吧我到目前为止找到的最好的解决方案是使用产生输出的=item S< >*

HEAD
    a   A

     *  B

    c   C

不完全是我想要的（*有点偏离）但无论如何

在pod项目中使用星号作为文本

2 个答案: