5 полезных советов для написания поддерживаемого кода

5 полезных и 5 вредных советов для поддерживаемого кода

Рассмотрим несколько советов, с которыми будет проще овладеть искусством «чистого кода».

Что скрывает в себе имя

Хорошее имя несет смысл – не жалейте сил на подбор и переименуйте существующие объекты. Все, кто будет читать ваш код, оценят это.

Чтобы облегчить процесс «придумывания» имени для переменной, функции или класса, запомните, что оно должно отвечать на три вопроса:

  1. Для чего существует переменная?
  2. Что она делает?
  3. Что использует?

Нужно серьезно отнестись к названиям, так как впоследствии это может стать наиболее значимой проблемой в процессе написания поддерживаемого кода.

Функции должны выполнять только одно действие

Функции, как правило, – основной элемент организации кода в любом ЯП, и умение их создавать хорошо структурированными – суть чистого кода.

Созданная функция должна быть компактной и не содержать большое дерево вложенности – не больше одного или двух уровней. Такой подход улучшает читабельность и внешний вид кода. Обязательным правилом поддерживаемого кода является проверка на нахождение всех элементов функции в одном уровне абстракции.

Допускать перемешивание этих уровней нежелательно (даже критично), т. к.:

  • это запутывает;
  • вы можете забыть, что происходит в коде;
  • со временем приводит к неуправляемому коду.

Аккуратнее с комментариями

Умеренное количество комментариев – идеальный вариант. Существует очень много примеров кода, где уровень полезности комментирования равен нулю. Не следует объяснять каждую строку кода (особенно с очевидным смыслом), не загромождайте код программы бесполезным текстом. Если оставляете документацию, то потрудитесь создать четкое, внятное, лаконичное и правдивое описание.

Помечайте свои комменты датой, чтобы другой разработчик смог понять актуальность написанного – это делает проще поддержку и помогает навести порядок в структуре кода.

Помните, что лучше написать несколько комментариев, чем хранить между строками «роман Толстого» – не создавайте беспорядок, а посвятите время уборке.

Больше:  Разница между прямым и обратным прокси

Сначала был «try-catch»

Обработка ошибок – это необходимая составляющая работы программиста. Однако проблема заключается не в самом процессе, а в аккуратном подходе и красивом способе отлова.

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

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

Форматирование в приоритете

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

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