Руководство разработчика по соглашениям об именовании
То, как вы называете переменные, функции и файлы, может показаться делом вкуса, но на самом деле это правило, которое влияет на продуктивность вашей команды и читаемость кода.
Почему соглашения об именовании важны
Код читают гораздо чаще, чем пишут. Единообразное соглашение об именовании помогает другим людям, а также вам в будущем, быстро понимать код.
Когда правила единообразны, уже само имя подсказывает, является ли что-то переменной, константой или классом, что сокращает бесполезный поиск.
Основные форматы кратко
- camelCase — первое слово со строчной буквы, первая буква последующих слов заглавная (myVariableName)
- PascalCase — первая буква каждого слова заглавная (MyClassName)
- snake_case — всё строчными буквами, слова соединены символами подчёркивания (my_variable_name)
- CONSTANT_CASE — всё заглавными буквами с подчёркиваниями, обычно для констант (MAX_COUNT)
- kebab-case — всё строчными буквами с дефисами, обычно для URL и CSS (my-class-name)
Соглашения по языку и контексту
Многие языки рекомендуют собственные соглашения. Python предпочитает snake_case для переменных и функций, JavaScript и Java используют camelCase, а большинство языков используют PascalCase для имён классов.
Константы часто записываются в CONSTANT_CASE независимо от языка, а kebab-case фактически является стандартом для путей URL и CSS-классов.
Единообразие важнее самого правила
Ни один формат не является абсолютно правильным. Важнее всего последовательно следовать правилу, о котором договорились в вашем проекте или команде.
Присоединяясь к существующей кодовой базе, отдавайте предпочтение её соглашениям, а не личному вкусу. Если нужно переименовать множество идентификаторов сразу, поможет конвертер регистра.