Когда-то давно я думал, что комментарии — это зло. «Хороший код говорит сам за себя!» — говорил я. Потом пришел кода в большой проект и потратил три часа на разбор функции processData(), которая делала… что-то.
📝 Главное правило: комментарии нужны не для очевидных вещей, а для объяснения сложных решений и бизнес-логики.
✅ Пишите почему, а не что
❌ // Уменьшаем баланс пользователя
✅ // Списываем сумму только после проверки, чтобы избежать дублей
✅ Избегайте очевидных комментариев
❌ // Устанавливаем X в 10
int x = 10;
✅ Объясняйте магию
Если формула или алгоритм нетривиальны, объясните, почему они такие.
// Используем формулу Гаусса для быстрого вычисления суммы от 1 до N
return (n * (n + 1)) / 2;✅ Следите за актуальностью
Старые, нерелевантные комментарии хуже, чем их отсутствие. Они вводят в заблуждение.
Какой самый худший комментарий вам встречался? 😅
🔔@lifeproger