Вы когда-нибудь задумывались о том, насколько читабелен ваш код? Хотите писать более читаемый код? Знаете кого-нибудь, кто не пишет читаемый код? Если ответ хотя бы на один из этих вопросов положительный, то вы находитесь в правильном месте.

Давайте посмотрим на код ниже:

int gmca(int MBY, int CY)
{
    if(S.PM())
        return null;
    else
    {     
        int res = CY - MBY;
        return res;
    }
}

Можете ли вы сказать, что делает этот код? возможно нет.

А теперь представьте ситуацию, когда вы только что вернулись из отпуска, открыли свою IDE и увидели код выше, сколько времени у вас ушло бы на то, чтобы понять этот код, если бы вы его написали? а если не написали, то как долго тогда?

Что ж, назовем «мальчика» по имени, этот код нечитабелен и не имеет значения, по какой причине вы/ваш коллега/ваш сотрудник (если он еще не уволен) его так написал.

Теперь посмотрите на тот же код с небольшими изменениями:

int getMufasasCurrentAge(int MufasasBirthYear, int currentYear)
{     
     if(Scar.pushMufasa())
         return null;
     else
     {            
         int MufasasCurrentAge = currentYear - MufasasBirthYear;
         return MufasasCurrentAge;
     }
}

Гораздо лучше, не так ли? И все это только потому, что мы использовали осмысленные имена для наших переменных. Все изменения имени заняли примерно 30 секунд. Эти 30 секунд стоят гораздо больше, когда мы смотрим вперед, вот несколько причин, почему:

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

Некоторые идеи, которые следует учитывать при именовании переменных и методов

  1. Имя переменной должно описывать информацию, представляемую переменной. Имя переменной должно кратко сообщать вам, что означает эта переменная.
  2. Вероятно, ваш код будет прочитан больше раз, чем написан. Поэтому отдайте предпочтение читабельности, а не скорости написания.
  3. Еще одна хорошая идея — принять стандартные соглашения об именах, чтобы вы могли принять одно глобальное решение в кодовой базе вместо нескольких локальных решений.

Примеры неправильных имен переменных

  1. temp/curr: даже если переменная является временной, вы все равно должны дать ей значимое имя, чтобы вы могли явно понять ее контекст.
  2. ценность . Что означает «стоимость»? Цена ужина? Или, может быть, вы посчитали общее количество птиц, как вы можете догадаться, мы не можем точно сказать, к какой переменной она относится, и более того, это просто создает путаницу.

Некоторые причины неправильного именования переменных

  1. Непонятное желание сделать код коротким.
  2. Экономия времени для перехода к следующей задаче.
  3. Лень.

Как предотвратить плохое название

  1. Всегда помните, что короткое не означает читабельное.
  2. Иногда экономия времени сейчас может стоить нам гораздо дороже в будущем, поэтому подумайте об этом в следующий раз, когда захотите быстро закончить и продолжить.
  3. Попробуйте поставить себя на место коллеги, которому нужно прочитать и поработать над кодом, который вы только что написали, и поймет ли он его.
  4. Не ленись.

Идеи и методы при именовании переменных

  1. Переменные: короткое, но значимое имя, которое сообщает случайному наблюдателю, что представляет собой переменная, а не то, как она используется. Начните со строчной буквы и используйте верблюжий регистр (смешанный регистр, начиная со строчной буквы). Примеры: userName, getAge….
  2. Класс: существительное, которое сообщает, что представляет класс. Начните с заглавной буквы и используйте верблюжий регистр для внутренних слов. Примеры: Студент, Налоговый калькулятор….
  3. Метод: глагол, который сообщает, что делает метод. Начните со строчной, если частная, или прописной, если публичная буква (на соответствующих языках) и используйте camelCase для внутренних слов. Примеры: pop(), pushMufasa(), calcTax()…..

Краткое содержание

Поздравляю, вы сделали важный шаг к тому, чтобы писать более читаемый код, убедитесь, что вы всегда отдаете себе отчет в том, что вы пишете, и старайтесь смотреть вперед в будущее своего кода, и помните, что иногда «Чтобы заработать деньги вам нужно не торопиться (но не слишком много :) )».

Надеюсь тебе понравилось.

Ваш.

Чен Бергер