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

Возьмите следующий фрагмент кода:

Что оно делает? Глядя на него в течение нескольких секунд, создается впечатление, что мы просматриваем массив, проверяем условие и устанавливаем значение, если это условие оценивается как истинное. Еще через несколько секунд мы видим, что функция находит максимальное значение массива. Однако нам потребовалось слишком много времени, чтобы понять это.

Чтение кода должно быть простым и понятным. Здесь есть несколько проблем с именованием, что влияет на читабельность:

// Most functions create a solution, what could be a better name?
function solution(arr)
// A lot of functions return values, what could be a better name?
let returnValue = arr[0]; 
// This is checking for a max value, how could we make this clearer?if (arr[i] > returnValue)

Теперь с этой обратной связью возьмите следующий код:

Эти изменения устраняют следующие проблемы:

  1. Название функции понятно, и теперь мы знаем, что она делает.
  2. Переменная максимального значения теперь имеет правильное имя, что дает понять, что мы сохраняем и находим максимальное значение.
  3. Условие для проверки того, превышает ли текущее значение хранимое максимальное значение, теперь устанавливается в собственную переменную, давая понять, что мы проверяем, больше ли текущее значение.

Это небольшой пример того, как простое изменение имен функций и переменных, а также создание новых переменных может повлиять на удобочитаемость вашего кода. Надеюсь тебе понравилось!