Найти тему
32 подписчика

Магические константы


Магическое число — это число, используемое непосредственно в коде без четкого объяснения его значения или происхождения.

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

Например:
// ДО
double rightAnswersPercent = (double)rightAnswersCount / 5;
Непонятно откуда взялось число 5? Почему 5, а не 6 или 10.

А вот если мы вынесем константу в переменную и обзовем правильно, то код будет читать как надо:
// ПОСЛЕ
int questionsCount = 5;
double rightAnswersPercent = (double)rightAnswersCount / questionsCount;
Теперь четко понятно, что означает число 5.

Иногда и с выделением переменной НЕ бывает понятно, откуда взялась константа:
int secondsInDay = 86400;

Если развернуть ее и написать откуда она взялась, то все становится понятно?
int secondsInDay = 24 * 60 * 60;

В приведенном примере использование арифметического выражения (24 часа 60 минут 60 секунд) вместо магического числа 86400 делает код более понятным и удобным для чтения. Арифметическое выражение легко проверить на корректность и оно явно показывает, к чему относится данное значение.

Так не возникнет "боли" у ваших коллег или у вас в будущем. Код говорит сам за себя.

Пишите читаемый и чистый код☺️

P/S. отрывок из будущего курса PRO C#. Чистый код

#полезные_материалы #чистый_код
1 минута