Skip to main content

Naming Conventions

Правила​

Назви повинні бути короткими, змістовними і вимовними. Кожна назва має бути:

  • Дієсловом, а не іменником: Зрозуміти, що робить створюваний елемент. Це допомагає точніше визначити призначення.
  • Значимою: Не надто абстрактно.
  • Короткою: Максимум 2 або 3 слова.
  • Такою, що вимовляється: Ми хочемо, щоб ми могли їх вимовляти.
  • Латинська назва в стандартизованих термінах: не трансліт а стандартизована термінологія.

Необхідно дотримуватись naming convention для кожної з мов програмування/бібліотек.

HTML and CSS​

Методологія БЕМ, для написання класів

Google HTML/CSS Style Guide: https://google.github.io/styleguide/htmlcssguide.html

JavaScript​

Користуйтеся правилами Naming Conventions AirBnb

  1. Eslint - може перевіряти та виправляти код у відповідності до стандарту
  2. TODO FIXME - прописуємо в коді це значення для того що треба зробити/поправити - напр., костиль.

Node​

Змінні та функції називаємо в camelCase, класи в UpperCamelCase

VUE​

  • Props пишуться в kebab-case
  • Змінні та функції в camelCase

API​

  • cebab-case
  • rest підхід

Template​

<Модуль?>.<розділ/інтерфейс>.<суфікс?>
│        │                    |
|        |                    └─⫸ .pt .form .table - опціонально
│        │
│        └─⫸ унікальна назва cebab-case
│
└─⫸ Модуль: core|advert - опціонально
  • Префікс - alias моудля з маленької букви
  • Суфікс - pt, form, table

Приклади

  • core.file-preview.pt
  • core.module-short.form

PostgreSQL​

Назви мають бути іменниками, малими літерами snake_case (нижнє підкреслювання).

  • ID - tablename_id,
  • PK - tablename_pk,
  • INDEX - tablename_:attr_idx,
  • FK - :tablename1_:tablename2_fk.

Зарезервовані атрибути (службові колонки):

  • cdate,
  • editor_date,
  • uid,
  • editor_id,
  • files.

Детальніше про них: https://help.softpro.ua/wiki/dev?post_id=2618184917602797119

Module & Readme​

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

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

Приклади

  • TELEGRAM;
  • SITE.

В кожній папці має бути файл README.md. Для цього використовується синтаксис Markdown

Redis​

Назви файлів, компонентів, параметрів мають бути іменниками, малими літерами роздільник :

db:ver?:group:name

Приклади

mbk:154:select:my.select