Перейти до основного вмісту

Угоди про імена

Загальні відомості​

При написанні програмного коду, та й під час роботи за комп'ютером завжди доводиться давати ім'я чомусь. При цьому слід дотримуватись:

  • по-перше, обмежень щодо допустимого набору символів
  • по-друге, загальноприйнятих та якимось чином стандартизованим стилям найменувань
Чутливість у іменах файлів

Наприклад, при присвоюванні імен файлів, є обмеження в наборах символів, які залежать від операційної системи (ОС), а також можуть бути чутливими до регістру.

При кодуванні ж конкретною мовою програмування визначено свій набір допустимих символів, причому не залежить від ОС, і чутливість до регістру визначено свою.

Угоди про імена

Стилі написання складових слів​

Загальні зауваження​

Стиль написання складових слів одна із найважливіших угод про найменування в мовах програмування, причому їх може бути дещо в одній мові, але для різних цілей.

Навіть серед найпоширеніших стилів написання складових слів у різних джерелах є плутанина.

Плутанина у стилях

Наприклад, стиль PascalCase часто плутають з camelCase, але це, проте, окремий стиль. Також зустрічається, що для camelCase вводять уточнюючі стилі, такі як upperCamelCase та lowerCamelCase.

Зроблено спробу усунути такі невідповідності, у тому числі в самих назвах цих стилів, які мають говорити самі за себе. Нижче описано основні стилі, очищені від будь-яких модифікацій.

Стилі написання складових слів

PascalCase​

У стилі PascalCase всі слова пишуться разом між собою, при цьому кожне слово всередині імені пишеться з великої літери.

Приклади: UserLoginCount, DefaultContentManager

Зустрічаються псевдоніми CamelCase, upperCamelCase, _ які, по можливості, не використовуйте_.

camelСase​

У стилі camelCase ("Верблюжий", "Горбатий") всі слова пишуться разом між собою і з великої літери починаються всі слова, крім першого.

Приклади: userLoginCount, defaultContentManager

Зустрічаються псевдоніми lowerCamelCase, які, по можливості, не використовуйте.

snake_case​

У стилі snake_case («Зміїний») всі слова поділяються символом підкреслення і пишуться малими літерами.

Приклади: user_login_count, default_content_manager

UPPER_SNAKE_CASE​

У стилі UPPER_SNAKE_CASE («Зміїний у верхньому регістрі») всі слова поділяються символом підкреслення і пишуться великими літерами.

Приклади: USER_LOGIN_COUNT, DEFAULT_CONTENT_MANAGER

kebab-case​

У стилі kebab-case ("Шашличний") всі слова поділяються символом дефісу і пишуться малими літерами.

Приклади: user-login-count, default-content-manager

Угоди у мовах​

У розділі коротко наводяться основні угоди про найменування у поширених мовах програмування.

C# (С-sharp, Си-шарп)​

  • PascalCase : класи, методи, властивості, інтерфейсні, структури, перерахування (перед іменем інтерфейсу додається символ I)
  • camelCase : змінні, включаючи параметри методів
  • UPPER_SNAKE_CASE : константи

Додатково:

F# (эф-шарп)​

  • PascalCase : типи, методи, властивості, поля, інтерфейсні типи, теги об'єднання
  • camelCase : параметри, внутрішні let-значення

Додатково:

C++​

См. Google C++ Style Guide

TypeScript​

  • PascalCase : імена типів, що перераховуються значення
  • camelCase : імена функцій, властивостей та локальних змінних

Додатково:

JavaScript​

  • PascalCase : класи та конструктори
  • camelCase : функції, об'єкти або екземпляри

Додатково:

Python (Пітон)​

  • PascalCase : класи
  • UPPER_SNAKE_CASE : константи
  • snake_case : всі інші імена

Додатково:

PEP (англ. Python Enhancement Proposal) — пропозиції щодо розвитку Python