Язык программирования Python (Сузи) - страница 15

• Длина физической строки не должна превышать 79 символов.

• Длинные логические строки лучше разбивать неявно (внутри скобок), но и явные методы вполне уместны. Отступы строк продолжения рекомендуется выравнивать по скобкам или по первому операнду в предыдущей строке. Текстовый редактор Emacs в режиме python–mode и некоторые интегрированные оболочки (IDE) автоматически делают необходимые отступы в Python–программах:

>def draw(figure, color="White", border_color="Black",

>         size=5):

> if color == border_color or \

>  size == 0:

>  raise "Bad figure"

> else:

>  _draw(size, size, (color,

>                     border_color))

• Не рекомендуется ставить пробелы сразу после открывающей скобки или перед закрывающей, перед запятой, точкой с запятой, перед открывающей скобкой при записи вызова функции или индексного выражения. Также не рекомендуется ставить более одного пробела вокруг знака равенства в присваиваниях. Пробелы вокруг знака равенства не ставятся в случае, когда он применяется для указания значения по умолчанию в определении параметров функции или при задании именованных аргументов.

• Также рекомендуется применение одиночных пробелов вокруг низкоприоритетных операций сравнения и оператора присваивания. Пробелы вокруг более приоритетных операций ставятся в равном количестве слева и справа от знака операции.

Несколько рекомендаций касаются написания комментариев.

• Комментарии должны точно отражать актуальное состояние кода. (Поддержание актуальных комментариев должно быть приоритетной задачей!) После коротких комментариев можно не ставить точку, тогда как длинные лучше писать по правилам написания текста. Автор Python обращается к неанглоязычным программистам с просьбой писать комментарии на английском, если есть хотя бы небольшая вероятность того, что код будут читать специалисты, говорящие на других языках.

• Комментарии к фрагменту кода следует писать с тем же отступом, что и комментируемый код. После ">#" должен идти одиночный пробел. Абзацы можно отделять строкой с ">#" на том же уровне. Блочный комментарий можно отделить пустыми строками от окружающего кода.

• Комментарии, относящиеся к конкретной строке, не следует использовать часто. Символ ">#" должен отстоять от комментируемого оператора как минимум на два пробела.

• Хороший комментарий не перефразирует программу, а содержит дополнительную информацию о действии программы в терминах предметной области.

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