Частая ошибка в разработке — называть пременные по их содержимому.
Классический плохой пример — назвать акцентный цвет в ЦСС по самому цвету. Когда переменную понадобится изменить, получится взрыв мозга:
Плохоbody { --red: rgb(227,0,22); } // Появились новые темы оформления, мозг взрывается body.theme-night { --red: blue; } body.theme-summer { --red: orange; }
Хорошоbody { --key-color: rgb(227,0,22); } body.theme-night { --key-color: blue; } body.theme-summer { --key-color: orange; }
Чтобы не взрывать мозг в будущем, называйте переменные по их смыслу и функции, а не по тому, что лежит внутри.
Иногда в имя переменной можно добавить кусочек, помогающий понять её содержимое или тип данных внутри. Это может упростить понимание кода, например, в языках без типизации или когда добавлять полноценную типизацию — оверкил.
Например, в Яваскрипте переменные, содержащие элементы страницы, часто помечают префиксом $. Это помогает отделить переменные с данными от переменных для работы с разметкой, быстрее понимать, что за переменная перед тобой и что с ней можно сделать.
// Данные
const userName = 'Константин'
const userEmail = 'k.maximov@web-o-grad.ru'
// DOM-элементы
const $userName = document.querySelector('.js-user-name')
const $userEmail = document.querySelector('.js-user-email')
Но с такими штуками надо быть осторожнее: важно не переборщить и убедиться, что вся команда знает и придерживается одинаковых правил именования.
Безусловно, всегда бывают исключения. Относитесь к этому совету как к «тупому правилу» и когда правило будет неприменимо — вы это поймёте.
См. также:
P. S. Это был совет о веб‑разработке. Хотите знать всё о коде, тестах, фронтенд‑разработке, цеэсэсе, яваскрипте, рельсах и джейде? Присылайте вопросы.