何时在Perl POD文档中需要空白行

Question

我注意到很多Pod在行之间有空行，例如

    code

    =head1 DESCRIPTION

    text

这些空白行是否严格需要，如果缺少特定的解析器会让他们感到沮丧。

perlpod中对 cut 的描述有点帮助，但我对其他构造感到疑惑：

  

要结束Pod块，请使用空行，   然后一行开头              “= cut”，然后是一个空白行。这让Perl（以及Pod              formatter）知道这是Perl代码恢复的地方。 （该              “= cut”之前的空白行在技术上是不必要的，   但很多              较旧的Pod处理器需要它。）

Answer 1

perldoc perlpod说“每个命令都需要后面的空白行，结束其段落”和“许多旧的Pod转换器在每个Pod命令之前和每个Pod命令之后需要行（包括”= cut“！ ）是一个空白行“。

段落用空行描绘，所以我发现很难想象在它前面没有空行的情况下启动一个命令段落。也许在文件的开头？

请注意，在Perl 6, Pod中重新定义，以便不再需要命令（之前和之后）的空行。

Answer 2

• 来自POD::Parser

请注意POD具有“段落”的概念：这是在空白（读取：空）行之后开始的，只有文件开头的一个例外，它也是一个段落。这意味着尤其是命令（例如= head1）必须以空行开头; 结束不是空行。

• 另见perlpodspec 找到空白行的原因 需要的。