SashaBus
Местный
- Тема Автор
- #1
Ты написал функцию на 300 строк? Поздравляю, ты создал технический долг. Чистый код — это не про «красивые скобочки», а про читаемость, простоту и предсказуемость. Давай разберём основные принципы, которые превратят твоё «говно» в «годно».
1. Имена переменных, функций, классов.
Плохо: a, tmp, data, x1, res. Хорошо: user_age, is_logged_in, get_user_by_id(), calculate_tax().
Имя должно отвечать на вопросы: что это? зачем? Не экономь буквы. Современные IDE имеют автодополнение, так что customer_orders_list не сложнее напечатать, чем col.
2. Длина функций.
Функция должна делать одно действие и занимать не больше 20-30 строк. Если видишь, что функция «и ищет пользователя, и обновляет его, и отправляет письмо, и логирует» — разбивай на три-четыре маленькие функции. Это называется Single Responsibility Principle (принцип единственной ответственности).
Пример плохого:
python
def process_order(order_id):
# 50 строк: проверка заказа, списание денег, обновление склада, отправка письма, запись в лог
Хорошо:
python
def process_order(order_id):
order = get_order(order_id)
validate_order(order)
charge_payment(order)
update_stock(order)
send_confirmation_email(order)
log_order_processed(order)
3. Комментарии.
Комментарии нужны только когда код сам по себе неочевиден. Хороший комментарий объясняет почему сделано так, а не что делает код (что и так видно).
Плохо:
python
# увеличиваем i на 1
i += 1
Хорошо:
python
# Из-за бага в API стороннего сервиса, первый запрос всегда возвращает 500,
# поэтому повторяем через 100 мс
retry_request()
4. Не повторяйся (DRY).
Если ты скопировал один и тот же код в три места — через месяц ты забудешь об одном из них, и баг будет жить вечно. Вынеси повторяющийся код в функцию или класс.
5. Обработка ошибок.
Не проглатывай ошибки. Это когда ты пишешь try { ... } catch { } и ничего не делаешь. Ты не решил проблему, ты её спрятал. Логируй ошибку, пробрасывай дальше или возвращай понятный статус.
Вайб: Когда ты открываешь свой код через полгода и сразу понимаешь, что там написано — ты достиг дзена. Если тебе страшно открыть свой же код — срочно переписывай, пока не поздно.
1. Имена переменных, функций, классов.
Плохо: a, tmp, data, x1, res. Хорошо: user_age, is_logged_in, get_user_by_id(), calculate_tax().
Имя должно отвечать на вопросы: что это? зачем? Не экономь буквы. Современные IDE имеют автодополнение, так что customer_orders_list не сложнее напечатать, чем col.
2. Длина функций.
Функция должна делать одно действие и занимать не больше 20-30 строк. Если видишь, что функция «и ищет пользователя, и обновляет его, и отправляет письмо, и логирует» — разбивай на три-четыре маленькие функции. Это называется Single Responsibility Principle (принцип единственной ответственности).
Пример плохого:
python
def process_order(order_id):
# 50 строк: проверка заказа, списание денег, обновление склада, отправка письма, запись в лог
Хорошо:
python
def process_order(order_id):
order = get_order(order_id)
validate_order(order)
charge_payment(order)
update_stock(order)
send_confirmation_email(order)
log_order_processed(order)
3. Комментарии.
Комментарии нужны только когда код сам по себе неочевиден. Хороший комментарий объясняет почему сделано так, а не что делает код (что и так видно).
Плохо:
python
# увеличиваем i на 1
i += 1
Хорошо:
python
# Из-за бага в API стороннего сервиса, первый запрос всегда возвращает 500,
# поэтому повторяем через 100 мс
retry_request()
4. Не повторяйся (DRY).
Если ты скопировал один и тот же код в три места — через месяц ты забудешь об одном из них, и баг будет жить вечно. Вынеси повторяющийся код в функцию или класс.
5. Обработка ошибок.
Не проглатывай ошибки. Это когда ты пишешь try { ... } catch { } и ничего не делаешь. Ты не решил проблему, ты её спрятал. Логируй ошибку, пробрасывай дальше или возвращай понятный статус.
Вайб: Когда ты открываешь свой код через полгода и сразу понимаешь, что там написано — ты достиг дзена. Если тебе страшно открыть свой же код — срочно переписывай, пока не поздно.