Все записи

5 привычек, которые делают код чище

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

Матвей.jpg

1. Давать осмысленные имена сразу же

Хорошие названия переменных, функций и классов экономят время всей команде: код проще читать, легче понимать и поддерживать. А еще чем меньше вопросов «что делает эта функция?» или «что содержит переменная?», тем лучше.

2. Декомпозировать код и избегать вложенности

if внутри if или for внутри for путают: каждое разветвление создает еще одну ветку, которую приходится держать в голове. Лучше разбить логику на небольшие части — код становится прозрачнее и надежнее.

как не надо:
функция заказать_пиццу(адрес):
  если адрес_валиден(адрес):
    если у_ресторана_ингредиенты():
      если клиент_может_платить():
        печать "Пицца заказана!"
      иначе:
        печать "Недостаточно денег"
    иначе:
      печать "Нет ингредиентов"
  иначе:
    печать "Адрес некорректный"


как надо:
функция заказать_пиццу(адрес):
  если не адрес_валиден(адрес):
    печать "Адрес некорректный"
    вернуть
  
  если не у_ресторана_ингредиенты():
    печать "Нет ингредиентов"
    вернуть
  
  если не клиент_может_платить():
    печать "Недостаточно денег"
    вернуть
  
  печать "Пицца заказана!"

3. Регулярно делать рефакторинг

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

4. Настроить линтер и форматер

Линтер — статический анализатор кода, который следит за определенным стилем написания кода. Так как у каждого из нас свой подход, нам нужен «инструмент-судья», который беспристрастно оценит оформление кода. Форматер помогает автоматически исправить код и привести его к единому виду.

5. Комментировать только неочевидную бизнес-логику

Комментарии полезны, если они объясняют то, что нельзя понять из кода. Например, когда понимаем, что участок кода содержит особенность бизнес-логики, которая еще не ясна новому сотруднику. Но важно помнить, что избыток пояснений превращает понятный код в мешанину из кода и комментариев. Принцип простой: объясняем редкие, действительно сложные места и не трогаем остальное.


Похожие новости

Инструменты, которые упрощают iOS-разработку

Старый код усложняет рефакторинг, тесты в команде запускаются по-разному, баги не воспроизводятся на хорошем Wi-Fi, а после обновления инструментов локальная сборка начинает расходиться с CI — по отдельности все это мелочи, но именно они постепенно начинают тормозить разработку.

В статье Ринат, iOS-разработчик Naumen, рассказывает об инструментах, которые помогают ему решать такие задачи и упрощать повседневную работу.

ИИ против ИИ: кто победит в кибербезопасности

С каждым днем кибератаки становятся дешевле, быстрее и убедительнее — во многом за счет ИИ. То, что еще недавно казалось фантастикой, сегодня стало вполне рабочим инструментом: от персонализированного фишинга до реалистичных дипфейков.

Денис — руководитель группы мониторинга и анализа инцидентов информационной безопасности в Naumen. Его команда отслеживает события в инфраструктуре, расследует инциденты и помогает коллегам разбираться с вопросами киберграмотности.

В статье на Хабре Денис рассказывает, какие именно изменения привнес ИИ в атаки, почему классическая модель защиты начинает давать сбои и где ИИ в защите действительно приносит пользу.

Как отдохнуть на майских и не потерять эффективность

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

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

Все новости