Post #323

#плохойкод Сегодня продолжаем серию о том, как не надо писать код. Смешение стилей Скажем, в Python многие любят использовавть snake case, то есть соединять слова между собой нижним подчеркиванием, в результате получаются вот такие переменные: my_variable, my_other_variable. А где-то принято использовать camel case: myVariable, myOtherVariable. И тут важна последовательность - если в коде проекта уже принят один стиль, не надо туда добавлять переменные, использующие другой стиль, так чтобы my_variable соседствовали с myVariable. Это же касается и, к примеру, переноса фигурных скобок (если они есть в языке) - переносить во всем проекте их надо одинаковым образом, а не где-то с новой строки, а где-то нет. Названия для переменных Худшее, что можно придумать - это называть переменные x, y, z, a, b, c, var1, var2, num1, num2 и так далее. Имя переменной должно рассказывать о том, что в ней содержится (помните, что код должен быть читаемым и понятным для другого человека, не только для вас одного?). Придумывайте информативные имена, например: average_salary, person_age, count_clicks - никаких переменных в одну букву. Исключение: переменные итераторов (for int i; i++) - в таких циклах традиционно используют переменные i, j, k. Не забывайте и про имена функций - они тоже должны быть «говорящими». Не называйте функции, например, do_everything() или do_calculations() - из такого имени непонятно, что именно функция делает или считает, нужно конкретнее: find_person_by_id() - например, ни у кого не вызовет недопонимания. Магические цифры Magic numbers - это когда вы используете в коде просто цифры. Например: x = y * 100 / 2 + 365 - и читающему код непонятно, почему мы умножаем y именно на 100 и делим именно на 2, что это за 365, и так далее. Как это исправить? Использовать константы вместо чисел, например: DAYS_IN_A_YEAR = 365 PERCENT_VALID = 100 DIVIDE_RATE = 2 x = y * PERCENT_VALID / DIVIDE_RATE + DAYS_IN_A_YEAR Пример - вымышленный, и смысла в этом вычислении нет, он чисто для демонстрации того, как избегать магических чисел. И да, как вы могли заметить, x и y - это плохие названия для переменных. 🙂