Читаемый код: 7 правил для новичка

Код читают гораздо чаще, чем пишут. Эти семь правил помогут сделать ваши программы понятными — и вам, и другим.

1–3. Имена, короткие функции, один уровень

Давайте переменным и функциям говорящие имена: «total_price» лучше, чем «t». Разбивайте программу на короткие функции, каждая из которых делает одно дело.

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

4–5. Отступы и единый стиль

В Python отступы — часть синтаксиса, поэтому держите их ровными (4 пробела на уровень). Единый стиль по всему проекту важнее, чем «идеальный» стиль в одном месте.

Не смешивайте табы и пробелы — это частый источник ошибок у новичков.

6. Комментарии по делу

Комментируйте «почему», а не «что»: код и так показывает, что он делает. Поясняйте неочевидные решения и хитрые места.

Устаревший комментарий хуже отсутствующего: обновляйте их вместе с кодом.

7. Убирайте лишнее

Удаляйте неиспользуемые переменные, закомментированные куски и дубли. Чем меньше шума, тем проще читать.

Короткий и честный код почти всегда лучше «умного», но запутанного.

Частые вопросы

С чего начать? С понятных имён — это даёт наибольший эффект за наименьшие усилия.

Нужен ли линтер новичку? Полезен, но сначала выработайте привычки вручную, например тренируясь в «Дрон Кодере».