Пишем красивый и читабельный код

Общедоступный код – это очень полезно. Вне зависимости от мотивации, ваши старания могут оказаться напрасными, если ваш код окажется сложным для понимания или использования другими.

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

Zen of Python (Дзен Питона) – это что-то вроде мини-инструкции и краткого руководства по оформлению кода для Python.

Популярные инструкции по оформлению кода включают в себя:

1. PEP-8 инструкция по оформлению кода

2. Идиомы и Эффективность в Python

3. Инструкции по оформлению кода от Google для Python

В этих инструкциях идет обсуждение того, как использовать: пробелы, запятые, именование объектов и т.д. Несмотря на то, что возможны конфликты в некоторых ситуациях, цель у всего этого одна – «Чистые, читаемые и отлаживаемые стандарты оформления кода».

Применяйте одну из инструкций, или следуйте своей, но не отходите кардинально от общепринятых стандартов.