Когда нужны пустые строки в документации Perl POD

Question

Я заметил, что во многих Pod есть пустые строки между строками, такие как

    code

    =head1 DESCRIPTION

    text

Если эти пустые строки строго необходимы, нужно ли расстраивать определенные парсеры, если они отсутствуют.

Описание для cut в perlpod немного помогает, но мне было интересно узнать о других конструкциях:

Чтобы завершить блок Pod, используйте пустую строку, затем строку, начинающуюся с "= вырезать ", и пустая строка после него.Это позволяет Perl (и средству форматирования Pod) знать, что именно здесь возобновляется код Perl.(Пустая строка перед "= cut" технически не требуется, но это требуется многим старым процессорам Pod.)

Answer 1

perldoc perlpod говорит, что «каждой команде нужна пустая строка после нее, чтобы завершить абзац» и «Многим более старым трансляторам Pod требуются строки перед каждой командой Pod и после каждой команды Pod (включая" ​​= вырезать "!) как пустую строку".

Абзацы очерчены пустыми строками, поэтому я затрудняюсь представить начало командного абзаца без пустой строки, непосредственно предшествующей ему. Может быть, в начале файла?

Обратите внимание, что в Perl 6 Pod переопределен, так что пустые строки вокруг команд (до и после) больше не нужны.

Answer 2

• С POD :: Parser

Обратите внимание, что POD имеет понятие "параграфы": это что-то, начинающееся после пустой строки (читай: пустая), за единственным исключением начала файла, который также запускает абзац. Это означает, что особенно команде (например, = head1) должна предшествовать пустая строка ; END - не пустая строка.

• см. perlpodspec также, вы будете найти причину, почему пустые строки необходимо.