Как правильно называть переменные

Переменные нужны для хранения информации. Это своеобразная «коробка» для данных с уникальным именем. Туда можно положить любое значение и потом менять его сколько угодно раз. Важно назвать переменные так, чтобы даже через несколько месяцев, понять, что и как обозначается в коде. Разберёмся, как именовать переменные в JavaScript и PHP.

Базовые правила

Без них вы просто не сможете создать переменную.

Называйте переменную по правилам именования языка

В противном случае код будет выдавать ошибку. Обычно название переменной — это сочетание букв латинского алфавита, цифр и символа подчеркивания: _.

Для создания переменных в JavaScript используют специальные команды: var, let, const. Самый старый способ — команда var. Команды let и const появились относительно недавно в ES2015. Их поддерживают все современные браузеры.

• Переменная с именем age и без значения — var age;
• Переменная с именем maximum со значением «цифра 5» — let maximum = 5;
• Переменная с именем FEED_CAT и значением «строка 25 гр» — const FEED_CAT = "25 гр";

В PHP переменные создаются с помощью символа доллара в начале имени.

• Переменная с именем age и без значения — $age;
• Переменная с именем maximum со значением «цифра 5» — $maximum = 5;
• Переменная с именем FEED_CAT и значением «строка 25 гр» — $FEED_CAT = "25 гр";

Все правила вы найдёте в документации к языку: для JavaSrcipt — это MDN; для PHP — php.net.

Не используйте зарезервированные имена

Это имена, которые уже выполняют в языке конкретные функции. Если назвать переменную зарезервированным именем, вы получите синтаксическую ошибку:

var class;
let return;
const var;
// Ошибка в JavaScript

function echo() {}
<!-- Ошибка в PHP -->

Примеры зарезервированных имён: var, class, return и export. Полный список вы найдёте документациях для JavaScript и PHP.

Условные правила

Соблюдение этих правил не обязательно. Но они помогут сделать код более понятным для вас самих и других разработчиков.

Понятные имена

Не стоит называть переменные одной буквой, сокращениями, транслитом и просто как придёт в голову. Имя переменной должно кратко описывать её предназначение. Исключения — общепринятые аббревиатуры. Например, счётчики циклов принято называть переменными i, j и k. Кнопку button можно сократить до btn.

Плохо: a, b, var1, var2 и adsf. Такие имена не несут смысловой нагрузки. Открыв код через некоторое время, вы не поймёте, для чего здесь эта переменная. Придётся вспоминать весь процесс с нуля.

Хорошо: inputBtn, result и onSubmit. Из названия понятно, что тут делает эта переменная.

var a = function(b) {
 return 2 * Math.PI * b;
}
var l = a(5);
// Непонятно, что это за функция и что мы получим в итоге.

Перепишем код, используя хорошее именование и получим функцию, считающую длину окружности.

var getCircleLength = function(radius) {
 return 2 * Math.PI * radius;
}
var length = getCircleLength(5);

Единый стиль написания

Есть два основных принципа написания многословных переменных. Не смешивайте их в одном скрипте:

• Snake_case — для разграничения слов использует нижнее подчеркивание. Принято использовать в PHP. Например: cat_food, maximum_count и on_click_button
• CamelCase — использует заглавную букву. Принято использовать в JavaScript. Например: catFood, maximumCount и onClickButton

Общепринятые подходы

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

• значение — существительное: cat, dog;
• массив — существительное в множественном числе: cats, dogs;
• функция — глагол: download, update;
• класс — существительное с заглавной буквой: Cat, Dog;
• константа — всё имя пишется заглавными буквами в стиле snake_case: MAXIMUM_FOOD, LIMIT_X;
• обработчик — имя описывает событие, по которому он вызывается. Как правило, содержит префикс on или постфикс Handler: onButtonClick, formSendHandler.

Использование этих правил сделает ваш код намного понятнее.

«Доктайп» — журнал о фронтенде. Читайте, слушайте и учитесь с нами.