Каждое число в коде считается «магическим числом»?

То есть каждое число в коде, которое мы отправляем методу в качестве аргумента, считается магическим числом? Для меня это не должно. Я думаю, что если какое-то число, скажем, для минимальной длины имени пользователя, и мы начинаем использовать «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 легче понять, чем переменная с именем "senceValue ".

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

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

Я бы предложил три ключевых фактора при принятии решения, должно ли что-то быть постоянным объявлением:

1. Является ли число чем-то точно и кратко представимым
2. Существуют ли вероятные сценарии, при которых значение должно было бы измениться, но код не должен был бы быть переписан
3. Будет ли тот, кто видит число, склонен распознавать его быстрее или менее быстро, чем тот, кто видит названную константу?

Нечто подобное пи, вероятно, следует записывать как именованную константу, а не как числовой литерал, поскольку числовой литерал может быть излишне многословным, излишне неточным или и тем, и другим. Что-то вроде количества слотов в кеше должно быть именованной константой (хотя см. Примечание ниже), чтобы обеспечить возможность расширения кеша без необходимости изменять весь код, который его использует. Такие вещи, как числа «4», «28» и «29» в утверждении, if ((year % 4)==0) FebruaryDays = 29; else FebruaryDays = 28;вероятно, не должны называться константами, поскольку выражение почти наверняка более читабельно, чем if ((year % YearsBetweenLeapYears)==0) FebruaryDays = FebruaryDaysInLeapYear; else FebruaryDays = FebruaryDaysInNonLeapYear;. Обратите внимание, что разработчики стандартов указали, что продолжительность февраля 2100 в этом году не будет соответствовать вышеуказанной формуле, препятствие для правильной обработки таких дат (т. е. код не будет отключен из-за целочисленного переполнения или других подобных проблем).

Важное предостережение с правилом № 2 заключается в том, что в некоторых случаях код может опираться на жестко запрограммированные числа таким образом, который не может быть легко представлен именованной константой. Например, метод, который вычисляет перекрестное произведение двух векторов, переданных в качестве дискретных параметров, будет иметь смысл только при использовании на трехмерных векторах. Требуемое количество измерений не является значением, которое можно было бы существенно изменить без полного переписывания процедуры. Даже если предвидеть возможную потребность в вычислении перекрестного произведения трех четырехмерных векторов, использование именованной константы для значения «3» мало что сделает для удовлетворения этой потребности.

Это, как и все принципы, является вопросом степени. Вообще говоря, числовые литералы в исходном коде более подозрительны, чем они больше. Максимальная длина, например 10, или адрес памяти, такой как 0x587FB0, явно плохая практика - почти наверняка вам рано или поздно придется повторять эти значения более одного раза, что создает риск несовместимости и незначительных ошибок в местах, которые не были изменилось.

0 находится на другом конце шкалы; это все еще подозрительно, но не так сильно. Используете ли вы 0 в качестве значения дозорного? Тогда вам, вероятно, следует использовать символическую константу вместо этого, просто потому, что константа может объяснить, что это значит. Это чрезвычайно укоренившееся культурное соглашение типа «0 означает успешное завершение»? Это, наверное, хорошо. Означает ли это «первый элемент в коллекции»? Это может быть безвредно, но если есть альтернативный метод, такой как first()я, вероятно, предпочел бы это.

Каждый неназванный номер, который не сразу очевиден из контекста, является магическим числом. Немного глупо определять числа, которые имеют значение, которое сразу видно из контекста.

В django (веб-фреймворк Python) я могу определить поле базы данных с необработанным числом, например:

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] +часть).