🤔 Что такое чистый код?

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

🚩Основные характеристики чистого кода

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

🟠Простота
Код должен быть простым и ясным, избегая излишней сложности. Это делает его более понятным и легким в поддержке.

🟠Последовательность
Следование единому стилю кодирования и соглашениям по наименованию. Это упрощает чтение и понимание кода.

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

🟠Модульность
Разделение кода на независимые модули или компоненты, которые можно разрабатывать, тестировать и поддерживать отдельно.

🟠Тестируемость
Код должен быть легким для тестирования. Хорошо написанный код обычно легко покрыть юнит-тестами.

🚩Принципы чистого кода

🟠Именование
Имена переменных, функций и классов должны быть осмысленными и описывать их назначение.

int age; // Понятно, что переменная хранит возраст

🟠Функции
Функции должны быть короткими и выполнять одну задачу.

     void calculateAndPrintTotal() {
         int total = calculateTotal();
         printTotal(total);
     }

🟠Комментарии
Комментарии должны объяснять, почему был написан определенный код, а не что он делает. Хорошо написанный код должен быть самодокументируемым.

// Calculate the total price including tax
int totalPrice = calculateTotalPrice();

🟠Форматирование
Единый стиль форматирования делает код более читабельным. Используйте отступы, пробелы и пустые строки для улучшения структуры кода.

     if (isValid) {
         process();
     } else {
         handleError();
     }

🟠Обработка ошибок
Обработка ошибок должна быть понятной и не загромождать основной код.

     try {
         processFile(file);
     } catch (IOException e) {
         logError(e);
     }

🟠Магические числа и строки
Избегайте использования магических чисел и строк. Вместо этого используйте константы с осмысленными именами.

static final int MAX_USERS = 100;

Ставь 👍 и забирай 📚 Базу знаний