Вам бонус- начислено 1 монета за дневную активность. Сейчас у вас 1 монета

Имена переменных в JavaScript и других языках Snake case CamelCase. Стили написания названий в программировании

Лекция



Привет, сегодня поговорим про имена переменных в javascript, обещаю рассказать все что знаю. Для того чтобы лучше понимать что такое имена переменных в javascript, camel case, snake case, kebab case, pascal case, upper case, camelcase, snakecase, kebabcase, pascalcase, uppercase , настоятельно рекомендую прочитать все из категории Выполнение скриптов на стороне клиента JavaScript, jqvery, JS фреймворки (Frontend).

  1. Имена переменных в Js
  2. Зарезервированные имена в Js
  3. Правильный выбор имени в Js

Один из самых важных навыков программиста — умение называть переменные правильно.

Имена переменных в Js

На имя переменной в JavaScript наложены всего два ограничения.

  1. Имя может состоять из: букв, цифр, символов $ и _
  2. Первый символ не должен быть цифрой.

Например:

var myName;
var test123;

Что здесь особенно интересно - доллар '$' и знак подчеркивания '_' являются такими же обычными символами, как буквы:

1 var $ = 5; // объявили переменную с именем '$'
2 var _ = 15; // переменная с именем '_'
3
4 alert($);

А такие переменные были бы неправильными:

var 1a; // начало не может быть цифрой
var my-name; // дефис '-' не является разрешенным символом

Регистр букв имеет значение

Переменные apple и AppLE - две разные переменные.

Русские буквы допустимы, но не рекомендуются

Можно использовать и русские буквы:

1 var имя = "Вася";
2 alert(имя);
Технически, ошибки здесь нет, но на практике сложилась традиция использовать в именах только английские буквы.

Зарезервированные имена

Существует список зарезервированных слов, которые нельзя использовать при именовании переменных, так как они используются самим языком, например: var, class, return, implements и др.

Некоторые слова, например, class, не используются в современном JavaScript, но они заняты на будущее. Некоторые браузеры позволяют их использовать, но это может привести к ошибкам.

Следующий пример будет работать во многих старых браузерах, которые допускают использование слова 'class' и не сработает в современных. Они выдадут синтаксическую ошибку, попробуйте, запустите:

1 var class = 5;
2 alert(class);

Правильный выбор имени

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

Дело в том, что большинство времени мы тратим не на изначальное написание кода, а на его развитие.

А что такое развитие? Это когда я вчера написал код, а сегодня (или спустя неделю) прихожу и хочу его поменять. Например, вывести сообщение не так, а эдак.. Обработать товары по-другому, добавить функционал.. А где у меня там сообщение хранится?..

Гораздо проще найти нужные данные, если они правильно помечены, т.е. переменная названаправильно.

  • Правило 1. Никакого транслита. Только английский.

    Неприемлемы:

    var moiTovari;
    var cena;
    var ssilka;

    Подойдут:

    var myGoods;
    var price;
    var link;

    Если вы вдруг не знаете английский - самое время выучить. Об этом говорит сайт https://intellect.icu . Все равно ведь придется…

  • Правило 2. Использовать короткие имена только для переменных «местного значения».

    Называть переменные именами, не несущими смысловой нагрузки, например a, e, p, mg - можно только в том случае, если они используются в небольшом фрагменте кода и их применение очевидно.

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

  • Правило 3. Переменные из нескольких слов пишутся вместеВотТак.

    Например:

    var borderLeftWidth;

    Этот способ записи называется «верблюжьей нотацией» или, по-английски, «camelCase».

    Существует альтернативный стандарт, когда несколько слов пишутся через знак подчеркивания'_':

    var border_left_width;

    Преимущественно в JavaScript используется вариант borderLeftWidth, в частности во встроенных языковых и браузерных функциях. Поэтому целесообразно остановиться на нем.

    Еще одна причина выбрать «верблюжью нотацию» — запись в ней немного короче, чем c подчеркиванием, т.к. не нужно вставлять '_'.

  • Правило последнее, главное. Имя переменной должно максимально четко соответствовать хранимым в ней данным.

    Придумывание таких имен - одновременно коротких и точных, приходит с опытом, но только если сознательно стремиться к этому.

Позвольте поделиться одним небольшим секретом, который позволит улучшить ваши названия переменных и сэкономит вам время.

Бывает так, что вы написали код, через некоторое время к нему возвращаетесь, и вам надо что-то поправить. Например, изменить какую-то рамку «border…»

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

В этом случае, самый лучший ход - это переименовать переменную на ту, которую вы искали изначально. То есть, у вас в коде leftBorderWidth, а вы ее переименовываете на borderLeftWidth.

Зачем? Дело в том, что в следующий раз, когда вы захотите что-то поправить, то вы будете искать по тому же самому имени. Соответственно, это сэкономит вам время.

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

Смысл имени переменной - это «имя на коробке», по которому мы сможем максимально быстро находить нужные нам данные.

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

Храните в переменной то, что следует

Бывают ленивые программисты, которые, вместо того чтобы объявить новую переменную, используют существующую.

В результате получается, что такая переменная — как коробка, в которую кидают то одно, то другое, то третье, при этом не меняя название. Что в ней лежит сейчас? А кто его знает.. Нужно подойти, проверить.

Сэкономит такой программист время на объявлении переменной — потеряет в два раза больше на отладке кода.

«Лишняя» переменная — добро, а не зло.

Особенность : 3

  1. Создайте переменную для названия нашей планеты со значением"Земля". Правильное имя выберите сами.
  2. Создайте переменную для имени посетителя со значением "Петя". Имя также на ваш вкус.
Решение

Каждая строчка решения соответствует одному шагу задачи:

1 var ourPlanetName = "Земля"; // буквально "название нашей планеты"
2
3 var visitorName = "Петя"; // "имя посетителя"

Стили написания составных слов в программировании

Имена переменных  в JavaScript и других языках  Snake case CamelCase. Стили написания  названий  в программировании

Названия переменных можно бы сократить, например, до some и name, но тогда станет менее понятно, о чем речь.

Насколько это допустимо - зависит от скрипта, его размера и сложности.

Самые распространенные стили написания составных слов:

  • Camel case
  • Snake case
  • Kebab case
  • Pascal case
  • Upper case (+ snake case).

Snake case snake_case

Snake case (или snake_case, рус. змеиный_регистр) — стиль написания составных слов, при котором несколько слов разделяются символом подчеркивания (_), и не имеют пробелов в записи, причем каждое слово обычно пишется с маленькой буквы — «foo_bar», «hello_world» и т. д. Такой стиль написания используется для именования переменных и функций в исходном коде , и иногда для именования файлов на компьютере.

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

Варианты Snake case

Существуют некоторые модификации snake_case:

  • Вариант, в котором вместо символа подчеркивания используется дефис — kebab-case, или lisp-case
    • Вариант-модификация kebab-case, в котором каждое новое слово пишется с большой буквы — Train-Case
  • Вариант, в котором все буквы слов пишутся в верхнем регистре — SCREAMING_SNAKE_CASE

Смысл метафоры Snake case

В результате применения этого стиля получаются идентификаторы_длинные_как_змея .

Snake case принят за правило

Языки программирования, в которых snake_case принят за правило:

  • Perl
  • Python, для имен переменных, функций и методов
  • Ruby, для имен символов, методов и переменных
  • Rust, для имен переменных, функций и модулей
  • Имена столбцов и талиц в базах данных
  • имена файлов и директорий

CamelCase

CamelCase (с англ. — «ВерблюжийРегистр», также «ГорбатыйРегистр», «СтильВерблюда») — стиль написания составных слов, при котором несколько слов пишутся слитно без пробелов, при этом каждое слово внутри фразы пишется с прописной буквы. Стиль получил название CamelCase, поскольку прописные буквы внутри слова напоминают горбы верблюда (англ. Camel).

Частным случаем стиля является lowerCamelCase, когда с прописной буквы пишутся все слова, кроме первого.

Примеры CamelCase

Примеры CamelCase-написания: BackColor, backColor, CamelCase.

Иногда встречаются также следующие названия этого стиля:

Имена переменных  в JavaScript и других языках  Snake case CamelCase. Стили написания  названий  в программировании

Применение CamelCase

Имена переменных  в JavaScript и других языках  Snake case CamelCase. Стили написания  названий  в программировании
CamelCase

CamelCase широко используется в языках программирования:

  • В языке Java принято использовать UpperCamelCase для именования классов и lowerCamelCase — для именования экземпляров классов и методов.
  • В Microsoft .NET принято использовать UpperCamelCase для именования классов и методов.
  • В PEP8, руководстве по написанию кода на языке Python, стиль CamelCase предлагается к использованию для имен классов.
  • В языке Wolfram Language стиль CamelCase используется для именования переменных, функций и опций. При этом объекты, встроенные в язык, всегда именуются в стиле UpperCamelCase, а для объектов, создаваемых программистом, принято использовать lowerCamelCase.
  • В Go критически важно быть внимательным к соглашениям о наименованиях. Этот язык определяет доступность переменной, поля или метода для вызова исходя из того, со строчной или заглавной буквы начинается имя.

    PascalCase обязателен для экспортируемых полей и методов.
    camelCase обязателен для внутренних полей и методов.

Использование стиля CamelCase в коде программы определяется личным вкусом программиста, если проект невелик по размеру. В крупных проектах, как правило, существует специальный документ, определяющий правило создания имен (переменных, функций, констант и пр.) для всех участников проекта.

Некоторые среды разработки (например, Qt Creator) предоставляют возможность автозаполнения по прописным буквам при использовании CamelCase (sCM → setContentMargins).

Принято считать альтернативным способом создания имен в программном коде стиль_змеиный_регистр, через_подчеркивание, или его вариант шашлычный-регистр (позвоночный-регистр) с дефисами, используемый в Лиспе. Тем не менее стили можно смешивать (например: среднее_КоличествоЯблок), поскольку стили создания имен являются лишь условной договоренностью и не влияют на работу программы.

Собственно стили появились из-за того, что в коде программы желательно иметь осмысленные имена переменных (описывающие смысл содержащегося в переменной значения), но не слишком длинные, а правила синтаксиса языков программирования налагают ограничения на средства для создания имен (к примеру, в большинстве языков допускается использование только буквенных символов, цифр и знака подчеркивания).

kebab-case

kebab-case похож на snake_case, только в нем пробелы заменяются на дефисы. Слова также пишутся строчными буквами. Его можно смешивать с camelCase и PascalCase, но в этом нет смысла.

Пример bab-case для переменной bab case var – bab-case-var.

PascalCase

В PascalCase каждое слово начинается с заглавной буквы (в отличие от camelCase, где первое слово начинается со строчной).

Пример PascalCase для переменной pascal case var – PascalCaseVar.

Примечание: этот стиль часто путают с camelCase, но это, тем не менее, отдельный стиль.

UPPER_CASE_SNAKE_CASE

В UPPER_CASE_SNAKE_CASE все слова пишутся заглавными буквами, а пробелы заменяются знаками подчеркивания.

Пример UPPER_CASE_SNAKE_CASE для переменной upper case snake case var – UPPER_CASE_SNAKE_CASE_VAR.

Соглашения JavaScript

  • camelCase для переменных и методов.
  • PascalCase для типов и классов.
  • UPPER_CASE_SNAKE_CASE для констант.

Вау!! 😲 Ты еще не читал? Это зря!

К сожалению, в одной статье не просто дать все знания про имена переменных в javascript. Но я - старался. Если ты проявишь интерес к раскрытию подробностей,я обязательно напишу продолжение! Надеюсь, что теперь ты понял что такое имена переменных в javascript, camel case, snake case, kebab case, pascal case, upper case, camelcase, snakecase, kebabcase, pascalcase, uppercase и для чего все это нужно, а если не понял, или есть замечания, то не стесняйся, пиши или спрашивай в комментариях, с удовольствием отвечу. Для того чтобы глубже понять настоятельно рекомендую изучить всю информацию из категории Выполнение скриптов на стороне клиента JavaScript, jqvery, JS фреймворки (Frontend)

создано: 2014-10-07
обновлено: 2021-08-10
132508



Рейтиг 9 of 10. count vote: 2
Вы довольны ?:


Найди готовое или заработай

С нашими удобными сервисами без комиссии*

Как это работает? | Узнать цену?

Найти исполнителя
$0 / весь год.
  • У вас есть задание, но нет времени его делать
  • Вы хотите найти профессионала для выплнения задания
  • Возможно примерение функции гаранта на сделку
  • Приорететная поддержка
  • идеально подходит для студентов, у которых нет времени для решения заданий
Готовое решение
$0 / весь год.
  • Вы можите продать(исполнителем) или купить(заказчиком) готовое решение
  • Вам предоставят готовое решение
  • Будет предоставлено в минимальные сроки т.к. задание уже готовое
  • Вы получите базовую гарантию 8 дней
  • Вы можете заработать на материалах
  • подходит как для студентов так и для преподавателей
Я исполнитель
$0 / весь год.
  • Вы профессионал своего дела
  • У вас есть опыт и желание зарабатывать
  • Вы хотите помочь в решении задач или написании работ
  • Возможно примерение функции гаранта на сделку
  • подходит для опытных студентов так и для преподавателей



Комментарии


Оставить комментарий
Если у вас есть какое-либо предложение, идея, благодарность или комментарий, не стесняйтесь писать. Мы очень ценим отзывы и рады услышать ваше мнение.
To reply

Выполнение скриптов на стороне клиента JavaScript, jqvery, JS фреймворки (Frontend)

Термины: Выполнение скриптов на стороне клиента JavaScript, jqvery, JS фреймворки (Frontend)