“Чистый код” – это код, который читается как хорошо написанная книга, а не как загадочный шифр.
“Чистый код” в контексте наименований переменных означает использование таких имен переменных, которые делают код понятным, читаемым и легко поддерживаемым. Хорошие имена переменных играют ключевую роль в понимании программы, особенно в командной разработке или при долгосрочной поддержке проекта.
Основные принципы чистого кода для наименования переменных:
1. Говорящее имя
Имя переменной должно четко описывать её назначение.
❌ Плохо:
int d; // Что такое “d”? Дни? Дата? Длина?
✅ Хорошо:
int daysSinceLastLogin; // Название ясно указывает на суть переменной.
2. Длина имени соответствует контексту
• Короткие имена подходят для локальных переменных, используемых в небольших блоках:
for (int i = 0; i < items.length; i++) { … }
• Для глобальных или сложных переменных имена должны быть более описательными:
Map<String, Integer> userPurchaseHistory;
3. Отсутствие двусмысленности
Имена не должны путать разработчика:
❌ Плохо:
int account; // Это номер? Баланс? Статус?
✅ Хорошо:
int accountBalance;
4. Использование общепринятых соглашений
Следует придерживаться стандартов, понятных команде:
• camelCase для переменных (userName, totalPrice).
• Глаголы для булевых переменных:
boolean isValid;
boolean hasPermission;
5. Избегание сокращений и неявных имен
❌ Плохо:
String usrNm; // Коллеги могут не понять, что значит “usrNm”.
✅ Хорошо:
String userName; // Прозрачно и понятно.
6. Не кодируйте тип переменной в её имени
❌ Плохо (устаревший подход):
int intCounter; // Тип уже известен, дополнительное упоминание лишнее.
✅ Хорошо:
int counter;
7. Консистентность (единообразие) имен
Используйте одинаковый стиль для похожих сущностей. Например:
• Если используете total, не заменяйте на sum.
int totalOrders;
double totalRevenue;
8. Избегание “магических” значений в именах
Имена не должны быть загадочными:
❌ Плохо:
int q; // Что это такое?
✅ Хорошо:
int queryCount; // Ясно, что переменная связана с количеством запросов.
Итог:
В контексте понимания термина “чистый код” наименования переменных должны быть:
• Осмысленными: четко отражают назначение переменной.
• Краткими, но достаточными: содержат всю необходимую информацию без лишних деталей.
• Единообразными: следуют общепринятым соглашениям и стилю в проекте.
Как говорит Роберт Мартин в своей книге “Чистый код”:
“Имя переменной — это первый комментарий кода”.
