Рассмотрим самые распространенные стили написания составных слов.
В процессе написания кода нередко возникает необходимость дать название чему-либо (классу, переменной, методу, параметру и т.д.), и крайне важно, чтобы это наименование было достаточно понятным для других людей. Однако типичный синтаксический анализ языка рассматривает каждое слово как отдельное понятие. Поэтому при наименовании нередко используются составные слова. Необходимо определиться со стилем их написания, чтобы поддерживать последовательность в пределах одного проекта или рабочего пространства.
Стили составных слов
| Наименование стиля | Пример |
|---|---|
| Исходная переменная как строка | some awesome var |
| Camel Case | someAwesomeVar |
| Snake Case | some_awesome_var |
| Kebab Case | some-awesome-var |
| Pascal Case | SomeAwesomeVar |
| Upper Case Snake Case | SOME_AWESOME_VAR |
camelCase
camelCase должен начинаться со строчной буквы, а первая буква каждого последующего слова должна быть заглавной. Все слова при этом пишутся слитно между собой.
Пример camelCase для имени переменной camel case var – camelCaseVar.
snake_case
Чтобы писать в стиле snake_case, нужно заменить пробелы знаками подчеркивания. Все слова при этом пишутся строчными буквами. Иногда используют snake_case вместе с camelCase или PascalCase, но это снижает читаемость и противоречит сути самого стиля.
Пример snake_case для имени переменной snake case var – snake_case_var.
kebab-case
kebab-case похож на snake_case, только в нем пробелы заменяются на дефисы. Слова также пишутся строчными буквами. Этот стиль также иногда смешивают с другими, но это лишено смысла.
Пример kebab-case для переменной kebab case var – kebab-case-var.
При использовании kebab-case следует учитывать еще один нюанс — большинство текстовых редакторов воспринимают каждую часть такого составного слова как отдельное слово. В результате двойной щелчок мыши выделяет только один сегмент (например, kebab или case), а при навигации по словам с клавиатуры курсор перемещается между сегментами, а не через всё слово целиком. Это может затруднить редактирование по сравнению с другими стилями, где составное слово воспринимается как единое целое.
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.
Варианты применения
Имена файлов
Имена файлов, созданных вручную, желательно указывать в нотации snake_case. В этом случае название сохраняет читабельность и при этом вряд ли приведет к каким-либо проблемам в файловой системе, где различается регистр символов. Например, имя файла будет в стиле PascalCase, а разработчик в коде напишет его в camelCase. При компиляции и выполнении в среде Windows или macOS ошибок не будет, но они возникнут при запуске этого кода в среде Linux, где файловая система чувствительна к регистру. Использование snake_case в именах файлов позволяет избежать этой проблемы.