Как правильно называть переменные
Переменные нужны для хранения информации. Это своеобразная «коробка» для данных с уникальным именем. Туда можно положить любое значение и потом менять его сколько угодно раз. Важно назвать переменные так, чтобы даже через несколько месяцев, понять, что и как обозначается в коде. Разберёмся, как именовать переменные в 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 Примеры зарезервированных имён: 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 .
Использование этих правил сделает ваш код намного понятнее.
«Доктайп» — журнал о фронтенде. Читайте, слушайте и учитесь с нами.
Правильный выбор имени переменной
Материал на этой странице устарел, поэтому скрыт из оглавления сайта.
Более новая информация по этой теме находится на странице https://learn.javascript.ru/variables.
Правильный выбор имени переменной – одна из самых важных и сложных вещей в программировании, которая отличает начинающего от гуру.
Дело в том, что большую часть времени мы тратим не на изначальное написание кода, а на его развитие.
Возможно, эти слова не очевидны, если вы пока что ничего большого не писали или пишете код «только для записи» (write-only, написал 5 строк, отдал заказчику и забыл). Но чем более серьёзные проекты вы будете делать, тем более актуальны они будут для вас.
Что такое это «развитие»? Это когда я вчера написал код, а сегодня (или спустя неделю) прихожу и хочу его поменять. Например, вывести сообщение не так, а эдак… Обработать товары по-другому, добавить функциональность… А где у меня там сообщение хранится? А где товар.
Гораздо проще найти нужные данные, если они правильно помечены, то есть когда переменная названа правильно.
Правила именования
var moiTovari; var cena; var ssilka;var myGoods; var price; var link;Этот способ записи называется «верблюжьей нотацией» или, по-английски, «camelCase». Существует альтернативный стандарт, когда несколько слов пишутся через знак подчёркивания ‘_’ :
Позвольте поделиться одним небольшим секретом, который очень прост, но позволит улучшить названия переменных и сэкономит время.
Бывает так, что, написав код, мы через некоторое время к нему возвращаемся, надо что-то поправить. И мы примерно помним, что переменная, в которой хранится нужное вам значение, называется… Ну, скажем, borderLeftWidth . Мы ищем её в коде, не находим, но, разобравшись, обнаруживаем, что на самом деле переменная называлась вот так: leftBorderWidth .
Если мы ищем переменную с одним именем, а находим – с другим, то зачастую самый лучший ход – это переименовать переменную, чтобы имя было тем, которое вы искали.
То есть, в коде leftBorderWidth , а мы её переименуем на ту, которую искали: borderLeftWidth .
Зачем? Дело в том, что в следующий раз, когда вы захотите что-то поправить, то вы будете искать по тому же самому имени. Соответственно, это сэкономит вам время.
Есть причина и поважнее. Поскольку именно это имя переменной пришло в голову – скорее всего, оно больше соответствует хранимым там данным, чем то, которое мы придумали изначально. Исключения бывают, но в любом случае – такое несовпадение – это повод задуматься.
Чтобы удобно переименовывать переменную, нужно использовать хороший редактор JavaScript, тогда этот процесс будет очень простым и быстрым.
Смысл имени переменной – это «имя на коробке», по которому мы сможем максимально быстро находить нужные нам данные.
Не нужно бояться переименовывать переменные, если вы придумали имя получше.
Современные редакторы позволяют делать это очень удобно и быстро. Это в конечном счёте сэкономит вам время.
Бывают ленивые программисты, которые, вместо того чтобы объявить новую переменную, используют существующую.
В результате получается, что такая переменная – как коробка, в которую кидают то одно, то другое, то третье, при этом не меняя название. Что в ней лежит сейчас? А кто его знает… Нужно подойти, проверить.
Сэкономит такой программист время на объявлении переменной – потеряет в два раза больше на отладке кода.
«Лишняя» переменная – добро, а не зло.