Как называть переменные? - Михаил Смирнов

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

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

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

  • Имя переменной должно состоять из букв латинского алфавита, цифр, знака нижнего подчёркивания _
  • Имя переменной не может начинаться с цифры
  • Нельзя в качестве идентификатора брать слова, которые зарезервированы самим языком
  • Идентификатор должен быть уникальным (то есть не должен совпадать с именами других переменных, функций и тд)
  • В большинстве языков программирования строчные и заглавные буквы различны.

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

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

Никакого транслита. Только английский язык

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

Причем это выглядит полностью неграмотно, а то что неграмотно, то трудно воспринимать.

Вот примеры, как не надо:

А вот как надо:

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

Если имя состоит из нескольких слов

В данном случае если написать их слитно, то это очень плохо воспринимается:

В таких случаях положено слова как-нибудь разделять и можно выделить два самых популярных способа:

Первый случай называют верблюжьей нотацией(camelCase). Он весьма удобен и можно встретить в различных языках.

Во втором примере слова разделены знаком подчеркивания. Такой способ еще называют змеиной нотацией (snake_case). В этом случае имя выглядит немного длиннее, чем в первом способе.

Какой способ выбирать в основном дело вкуса, но нужно учитывать также традиции и рекомендации которые сложились в конкретном языке.

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

Переменные a, b, c, ds, и тд не несут в себе никакой смысловой нагрузки. Такие имена использовать на протяжении всей программы нельзя, так как попробуй потом разбери, что это за переменная и для чего она служит.

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

Не использовать «l» и «о» для коротких имен

Если имя переменной состоит из одного символа, то постарайтесь не использовать «l» и «o», потому что в некоторых шрифтах можно не отличить «l» от единицы, а «o» от нуля.

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

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

Также старайтесь, чтобы названия соответствовали той предметной области, с которой вы работаете.


Добавить комментарий

Ваш e-mail не будет опубликован. Обязательные поля помечены *

один × один =