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

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

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

Матвей.jpg

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

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

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

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

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


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

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

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

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

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

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

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


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

Тестирование верстки

В процессе тестирования верстки быстро становится понятно: один и тот же интерфейс может выглядеть аккуратно на макете, но разваливаться на практике. Чаще всего это проявляется в длине текста, переносах строк, состояниях элементов и отступах.

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

Как продакт и аналитик работают в одной задаче: три кейса из практики

Маша, продакт ITSM 365, рассказала в статье, как выстроить взаимодействие аналитика и продакта в одной задаче. В материале — три кейса из Delivery и Discovery, типичные ошибки и решения, которые помогли команде избежать хаоса и навести порядок в процессах.

Искусство сложных коммуникаций

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

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

В статье — наблюдения Иры и практические выводы о том, как проходить такие ситуации спокойнее и эффективнее.

Все новости