perl - Perl POD 文档中何时需要空行

Question

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

    code

    =head1 DESCRIPTION

    text

是否严格需要这些空行，如果缺少这些空行，特定的解析器是否会感到不安。

perlpod 中cut的描述有点帮助，但我想知道其他构造：

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

score 6 · Accepted Answer

perldoc perlpod说“每个命令后面都需要一个空行来结束它的段落”和“许多老的 Pod 翻译器要求每个 Pod 命令之前和每个 Pod 命令（包括“=cut”！）之后的行是一个空行”。

段落由空行划定，因此我发现很难想象在命令段落之前没有空行的情况下开始。也许在文件的开头？

请注意，在Perl 6 中，Pod被重新定义，因此不再需要围绕命令（之前和之后）的空行。

score 4 · Accepted Answer

请注意，POD 具有“段落”的概念：这是在空白（读取：空）行之后开始的内容，除了文件开头之外，它也是段落的开头。这意味着特别是命令（例如 =head1 ）必须以空行开头；END不是空行。

2 回答 2