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

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

    code

    =head1 DESCRIPTION

    text

Нужны ли эти пустые строки, расстраиваются ли определенные парсеры, если они отсутствуют.

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

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


perl perl-pod
person justintime    schedule 27.11.2010    source источник

Ответы (2)


arrow_upward
6
arrow_downward

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

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

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

person ephemient    schedule 27.11.2010
comment
@justintime, @ephemient: Действительно, когда-то это можно было использовать, чтобы обмануть вещи, чтобы они обращались как к компилятору, так и к подлатору, поскольку у них разные критерии для принятия решения о том, следует ли и как рассматривать подаграфы. - person tchrist; 27.11.2010
comment
=D@tchrist: чувак, в 1993 году это была самая крутая вещь, когда-либо иметь Perl-скрипт, который также был собственной справочной страницей! = Д - person Ether; 27.11.2010
comment
@Ether: Или в 1989 году. Обратите внимание, что "ignite" while 1 не вызывает предупреждений. Это для troff поддержки через wrapman. - person tchrist; 27.11.2010

arrow_upward
4
arrow_downward

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

  • см. также perlpodspec, вы найдете причину, по которой нужны пустые строки.
person Nikhil Jain    schedule 27.11.2010