perlstyle

perlstyle

=head1 НАЗВАНИЕ

perlstyle - Стиль написания Perl-кода

=head1 ОПИСАНИЕ

Безусловно, у каждого программиста есть свои собственные предпочтения относительно форматирования кода. Однако существуют некоторые общие рекомендации, которые сделают ваши программы читабельными, понятными и их поддержка не составит особого труда.

Самое важное - всегда запускать программы с флагом B<-w>. В случае необходимости для определённых участков кода этот режим можно явно отключить, используя C<no warnings> или переменную C<$^W>. Также следует всегда работать с C<use strict>, кроме случаев, когда вы точно знаете, почему эта прагма вам не подходит. Использование прагмы C<use sigtrap> и даже C<use diagnostics> может также оказаться полезным.

Есть только один пункт, который Ларри рекомендует строго выполнять, с целью сохранения эстетики форматирования кода - закрывающая фигурная скобка многострочного блока должна находиться на одной вертикали с ключевым словом, начинающим конструкцию. Кроме того, он имеет ряд других предпочтений, но не на настолько строгих:

=over 4

=item *

4х символьный отступ.

=item *

Открывающая фигурная скобка находится на той же строке, что и ключевое слово (если это возможно), иначе на одной вертикали с ним.

=item *

Пробел перед открывающей фигурной скобкой многострочного блока.

=item *

Однострочный блок может быть записан в одну строку, включая фигурные скобки.

=item *

Нет пробелов перед точкой с запятой.

=item *

В коротких однострочных блоках точка с запятой опускается.

=item *

Пробелы вокруг большинства операторов.

=item *

Пробелы вокруг "сложных" подпрограмм (внутри скобок)

=item *

Пустые строки между частями кода, реализующие разную логику.

=item *

"Не обнимать" else-условия

item *

Между именем функции и открывающей круглой скобкой нет пробелов.

=item *

Пробел после каждой запятой.

=item *

Разбивать длинные строки, оставляя на конце какой-либо оператор (кроме C<and> и C<or>).

=item *

Пробел после последней сбалансированной круглой скобки в текущей строке.

=item *

Выравнивать соответствующие элементы по вертикали.

=item *

Опускать излишнюю пунктуацию до тех пор, пока код остается читабельным.

=back

У Ларри есть причины для каждого из этих пунктов, но он не имеет претензий, если вы думаете по-другому.

Вот еще о чем стоит подумать:

=over 4

=item *

То, что вы I<МОЖЕТЕ> сделать что-то определённым образом вовсе не означает, что вы I<ОБЯЗАНЫ> это делать так. Perl спроектирован таким образом, чтобы дать вам возможность сделать любую вещь несколькими способами, и так, чтобы вы смогли выбрать наиболее читабельный вариант. Например: