Запах кода | Магические числа

Здравствуйте, сегодня мы возвращаемся к серии рефакторинга запахов кода, и в этом случае мы поговорим о запахе кода под названием Magic Numbers. Этот запах кода можно обнаружить, когда мы используем число, которому не хватает правильной семантики.

Причина

Числа, не имеющие семантики, делают вычисления более сложными для чтения.

Пример

Как видно из следующего примера, у нас есть 2 магических числа, которые довольно легко обнаружить, поскольку очень сложно понять, какой тип вычислений мы выполняем, просто наблюдая за этими значениями: 4.50 и 0.21

function calculateTotal(subtotal) {
  const total = subtotal + 4.50;
  return total + (total * 0.21);
}

Решение

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

const SHIPPING_FEE = 4.50;
const SALES_TAX = 0.21;

function calculateTotal(subtotal) {
  const total = subtotal + SHIPPING_FEE;
  return total + (total * SALES_TAX);
}

Преимущества

• Улучшение читабельности и сопровождаемости кода.
• Вы сделаете следующего человека, которому придется просматривать эту часть кода, очень счастливым 😋 jiji

Спасибо, что читаете меня 😊