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

Придумать правильные имена переменных, констант и функций бывает очень трудно, но грамотно выбранное имя намного облегчает чтение кода. Даже возвращаясь к собственным скриптам, бывает трудно понять, что делает та или иная функция и с какими переменными она работает.

Функции

Функция => выполнение действия => глагол. И никак по-другому!

    const render () => {...} 
    function multiply () {...}

Функции - предикаты

Это фунцкии, которые проверяют что-то на истинность. Они возращают либо true либо false. В JavaScript в начале имени функции ставиться префик 'is'.

    const isPrime () => {...}
    function isInteger () {...}

Функция должна говорить о том, что будет результатом её работы, а не о том, что она делает. Функции, начинающиеся c:

  • get – возвращают значение
  • calc – что-то вычисляют
  • create – что-то создают
  • check – что-то проверяют и возвращают логическое значение, и т.д.
  • show – что-то показывают
  • has – проверяют на наличие
  • can – проверяют на допуск

  • normalize – нормализация

    const getValue () => {...} 
const createElement () => {...} 
function hasProperty () {...}

Одна функция – одно действие.
Функция должна делать только то, что явно подразумевается её названием. И это должно быть одним действием. Два независимых действия обычно подразумевают две функции, даже если предполагается, что они будут вызываться вместе (в этом случае мы можем создать третью функцию, которая будет их вызывать).

Переменные

Числа

Тут все просто: number или num. Но лучше давать имя, соответствующее предназначению числа: например, denom (делитель).

    let number = 5;

Строки

Строки. Также всё просто: если произвольная строка, то её можно назвать string, text или sentence. В более конкретных случаях это может быть str, char или word.

    let word = "Яблоко";
    let text = "Lorem Ipsum - это текст-"рыба", часто используемый в печати и вэб-дизайне.";

Массивы

Массив - коллекция каких-то элементов, а у элементов есть имена. Идеальное имя для такого массива - это имя элемента во множественном числе: users, cars, numbers или, на крайний случай, items. 

    let fruits = ["Яблоко", "Апельсин", "Слива"];
    let cars = ["Lexus", "Lada", "Honda"];

Колличество

Если нужна переменная, содержащая количество чего-либо, используется комбинация:
сущность во множественном числе + count.

    let symbolsCount = 33;
    let robotsCount = 99;

Сущность во множественном числе без '+ count' всегда должна обозначать только коллекцию(массив).
Так обозначать количество (допустим машин) неправильно: 

    let cars = 25;

Антонимы

Если нужно иметь значения переменной до проведения каких-либо действия и после то можно использовать связку - valueBefore и valueAfter.
Либо использавать слова антонимы - start : finish, begin : end.

#basics
openImgPic