Чи кожне число в коді вважається "магічним числом"?

Отже, кожне число в коді, яке ми надсилаємо методу в якості аргументу, вважається магічним числом? Для мене це не повинно. Я думаю, якщо якась цифра, скажімо, вона є мінімальною довжиною імені користувача, і ми починаємо використовувати "6" в коді ... тоді так, у нас проблема з технічним обслуговуванням, і ось "6" - це магічне число .... але якщо ми викликаємо метод, який в одному з його аргументів приймає ціле число, наприклад, як i-й член колекції, і тоді ми передаємо "0" цьому виклику методу, в цьому випадку я не бачу, що "0" є магією число. Як ти гадаєш?

Якщо значення числа в контексті дуже чітке, я не думаю, що це проблема "магічного числа".

Приклад: Скажімо, ви намагаєтеся отримати підрядку рядка від початку до деякого маркера, і код виглядає приблизно так (уявна мова та бібліотека):

s := substring(big_string, 0, findFirstOccurence(SOME_TOKEN, big_string));

У цьому контексті значення числа 0 досить зрозуміле. Я думаю, ви могли б визначити START_OF_SUBSTRINGі встановити його на 0, але в цьому випадку я думаю, що це буде зайвим (хоча це був би правильний підхід, якби ви знали, що початок вашої підрядки може бути не 0, але це залежить від специфіки Ваша ситуація).

Інший приклад може бути, якщо ви намагаєтеся визначити, чи число парне чи непарне. Написання:

isEven := x % 2;

не так дивно, як:

TWO := 2;
isEven := x % TWO;

Тестування від'ємних чисел як

MINUS_ONE := -1;
isNegativeInt := i <= MINUS_ONE;

мені також дивно, я б швидше побачив

isNegativeInt := i <= -1;

bool hasApples = apples > 0;

Очевидно, нуль означає відсутність. Я вважаю 0 простішим для розуміння, ніж змінною під назвою "відсутність валу".

for(int i=0; i < arr.length; i++)

Очевидно, що 0 - це вихідна позиція. Мене бентежить змінна назва "firstPosition". Така змінна змусила б мене замислитись, чи може початкова позиція змінитися.

Я б запропонував три ключові фактори для вирішення питання, чи має щось бути постійною декларацією:

1. Чи є число чимось точно і стисло представним
2. Чи є якісь правдоподібні сценарії, за яких значення повинно було б змінюватися, але код не потрібно було б переписувати
3. Чи може хтось, хто бачить число, сприйнятий розпізнавати його швидше або менш швидко, ніж той, хто бачить названу константу

Щось на кшталт pi слід, мабуть, писати як названу константу, а не як числовий літерал, оскільки числовий літерал є сприйнятливим багатослівним, непотрібним, або обом. Щось подібне до кількості слотів у кеші, ймовірно, має бути названою константою (хоча див. Примітку нижче), щоб передбачити можливість розширення кеша без зміни коду, який його використовує. Такі речі, як числа "4", "28" та "29" у виписці, if ((year % 4)==0) FebruaryDays = 29; else FebruaryDays = 28;ймовірно, не повинні називатися константами, оскільки вираз майже напевно читабельніший, ніж if ((year % YearsBetweenLeapYears)==0) FebruaryDays = FebruaryDaysInLeapYear; else FebruaryDays = FebruaryDaysInNonLeapYear;. Зауважте, що керівники стандартів вказали, що тривалість лютого 2100 року в цьому році не буде відповідати вищевказаній формулі, перешкоджання правильному поводженню з такими датами (тобто код не зіткнеться з цілим числом переповнення або іншими подібними проблемами)

Важливим застереженням із правила №2 є те, що в деяких випадках код може покладатися на жорстко закодовані числа таким чином, який не може бути легко представлений названою константою. Наприклад, метод, який обчислює поперечний добуток двох векторів, переданих як дискретні параметри, буде мати значення лише при використанні на тривимірних векторах. Необхідна кількість вимірів не є значенням, яке змістовно може бути змінено без повного перезапису рутини. Навіть якби передбачити можливу потребу в обчисленні поперечного добутку трьох 4-мірних векторів, використання названої константи для значення "3" мало би мало для того, щоб було легше задовольнити цю потребу.

Це, як і всі принципи, питання ступеня. Взагалі кажучи, числові літерали у вихідному коді є більш підозрюваними, чим більше вони. Максимальна довжина, як 10, або адреса пам'яті, наприклад 0x587FB0, очевидно, є поганою практикою - майже впевнено, що рано чи пізно вам доведеться повторювати ці значення не один раз, створюючи ризик несумісності та тонких помилок, введених у місцях, де не було змінився.

0 - на іншому кінці шкали; це все ще підозріло, але не дуже багато. Чи використовуєте ви 0 як дозорне значення? Тоді вам, мабуть, слід використовувати символічну константу замість цього, лише тому, що константа може пояснити, що це означає. Це надзвичайно закріплена культурна угода на зразок "0 означає успішне завершення"? Це, мабуть, добре. Чи означає це "перший предмет у колекції"? Це може бути нешкідливим, але якщо є альтернативний метод, такий як first()я, мабуть, віддаю перевагу цьому.

Кожне неназване число, яке не відразу очевидно з контексту, - це магічне число. Це трохи нерозумно визначити числа, які мають значення, що відразу очевидно з контексту.

У django (python web Framework) я можу визначити деяке поле бази даних із необробленим числом, наприклад:

firstname = models.CharField(max_length=40)
middlename = models.CharField(max_length=40)
lastname =  models.CharField(max_length=40) 

що зрозуміліше (і рекомендована практика ), ніж сказати

MAX_LENGTH_NAME = 40
...
firstname = models.CharField(max_length=MAX_LENGTH_NAME)
middlename = models.CharField(max_length=MAX_LENGTH_NAME)
lastname =  models.CharField(max_length=MAX_LENGTH_NAME) 

тому що я навряд чи коли-небудь знадобиться змінювати довжину (і завжди можна порівняти max_lengthз польовою). Якщо мені потрібно змінити довжину поля після первинного розгортання програми, мені потрібно змінити його в точно одному місці на поле в моєму коді django, а потім додатково написати міграцію, щоб змінити схему БД. Якщо мені колись знадобиться посилання max_lengthна певне поле типу об’єкта, я можу це зробити безпосередньо - якщо ці поля визначали Personклас, я можу використовувати Person._meta.get_field('firstname').max_lengthдля отриманняmax_lengthвикористовується (що визначено в одному місці). Те, що ті самі 40 були використані для кількох полів, не має значення, оскільки я можу захотіти їх змінити самостійно. Довжина імені ніколи не повинна залежати від довжини прізвища чи прізвища; вони є окремими значеннями і можуть змінюватися незалежно.

Часто в індексах масиву можна використовувати неназвані числа; наприклад, якщо у мене є файл CSV даних, який я хочу вкласти в словник python, з першим елементом у рядку як словником, який keyя б написав:

mydict = {}
for row in csv.reader(f):
    mydict[row[0]] = row[1:]

Впевнений, що я міг назвати index_column = 0і зробити щось на кшталт:

index_col = 0
mydict = {}
for row in csv.reader(f):
    mydict[row[index_col]] = row[:index_col] + row[index_col+1:]

або гірше визначити, after_index_col = index_col + 1щоб позбутися від цього index_col+1, але це не робить код яснішим на мій погляд. Крім того, якщо я даю index_colім’я, я краще змушу код працювати, навіть якщо стовпець не 0 (звідси row[:index_col] +частина).