/ 

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

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

Строки

Традиционно название строковой переменной — существительное. Как и везде, мы должны понимать что находится в переменной по её названию. Со строкой сложно напортачить, используйте существительные и давайте более осмысленные имена, например:

const serverMessage = 'hello from server'
const componentHtml = '<h1>Hello</h1>'
const login = 'username'
const password = 'qwerty'
const ACCESS_TOKEN = 'xxxxx'

Числа

С числами уже интереснее, можно встретить общие практики которые есть почти в каждом проекте:

  • код чего-либо (code)
  • размер (size, length)
  • номер (number)
  • количество (count)

Использование этих слов привычно и не вызывает дополнительных вопросов:

const keyCode = 17
const numberFromEnd = 10
const maxWindowSize = 800
const minCharacterLength = 10
const newMessageCount = 2

Булевое значение

Лучшее название для булевой переменной — вопрос с ответом да-нет. Так-же часто встречаются в виде префиксов и суфиксов слова:

  • это (is)
  • содержит (has/contain)
  • может (can)
  • должен (shoud)
  • возможность (able)
const isPopupOpen = true;
const hasUpperLetters = true;
const containObject = false;
const shoudUpdate = false;
const disabled = true;

Массивы

Массивы это существительные во множественном числе. Оканчиваются на суффиксы s и es.

const users = [{ name: 'Yury'}];
const letters = ['A', 'B', 'C'];
const codes = [21, 37];

Объекты

Так-же как и строки. Мне это не очень нравится, т.к. нельзя сразу-же отличить строку от объекта. Можно добавлять суффикс obj, но это мне кажется уже лишним.

Важное правило, не дублируйте название объекта в названии свойства или метода:

// Плохо
const user = {
    userName: 'test',
    getUsername() {},
};

// Хорошо
const user = {
    name: 'test',
    getName() {},
};

Функции и методы

Для функций первое слово глагол:

  • init/initialize
  • compute
  • find
  • create (object, array…)
  • to (string, array…)
  • filter
const initApp = () => {};
const computeMaxHeight = () => {};
const findClosestElement = () => {};
const toString = () => {};
const filterUsers = () => {};

Симметричные пары

Общие:

  • old/new
  • begin/end
  • first/last
  • up/down
  • min/max
  • next/previous

Для функций:

  • get/set
  • add/remove
  • create/destroy
  • start/stop
  • insert/delete
  • increment/decrement
  • open/close
  • show/hide
  • suspend/resume

Если вы новичек в программировании, или плохо знакомы с английским языком, то вот вам лайфхак:

  1. Хорошо подумайте и назовите переменную на русском языке
  2. Переведите её через Google Translate

Это все что я хотел сказать о переменных. Для дополнительного чтения советую статью 90 рекомендаций по стилю написания программ на C++.

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

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

Плавный, нативный скрол

Выкиньте лишние библиотеки для прокрутки внутри страницы

Лайфхак. Номер телефона на сайте
Фронтенд

Лайфхак. Номер телефона на сайте

Надоели звонки от клиентов в 2 часа ночи? Покажите номер телефона на сайте только в рабочее время. Подробности в статье.

На чем тестировать JavaScript фреймворки
Фронтенд

На чем тестировать JavaScript фреймворки

На чем испробовать новую технологию или фреймоврк если нет сайд/пет проекта? Пара интересных задачек в этой заметке.