Как мы работаем
Блог
Подписаться на рассылку
Блог HR
Все записи

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

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

Матвей.jpg

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

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

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

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

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


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

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

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

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

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

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

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


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

Почему отдых работает не всегда

Впереди сезон отпусков — время, от которого мы обычно ждем восстановления, возможности выдохнуть и немного замедлиться после напряженного темпа. Но отпуск или длинные выходные не всегда помогают почувствовать себя лучше. Одна из причин — мы часто воспринимаем отдых как проект: заранее ждем конкретного результата, пытаемся провести «правильно», расписываем дни активностями.

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

Bus‑фактор: почему не надо быть незаменимым

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

Это называется bus-фактор ???? В посте рассказываем о нем подробнее, разбираем, почему это плохо, и делимся лайфхаками, что сделать, чтобы проект не рухнул без вас.

Как ИИ помогает разобраться в незнакомом проекте

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

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

Все новости