Принципи найменування файлів
У цьому матеріалі ми поговоримо про те, як організувати найменування файлів в проєкті.
Може здатися, що організація файлів — це справа смаку. Але насправді, тут потрібна система. В першу чергу, це корисно для вас: з часом у вас накопичуються сотні й тисячі файлів, і без осмисленого підходу до найменування орієнтуватися в них буде просто неможливо. Крім того, працювати ви будете, швидше за все, в команді. І корисно буде зробити так, щоб у ваших файлах могли розібратися не тільки ви, але й ваші колеги.
Основні принципи
При найменуванні файлів слід використовувати певні принципи. Давайте спочатку перерахуємо їх всі, а потім зануримося в деталі:
- У назвах файлів потрібно використовувати виключно латинські літери у нижньому регістрі.
- Назви файлів повинні бути осмисленими та відповідати проєкту.
- Якщо назва складається з декількох слів, відокремлюйте їх один від одного.
- Але при цьому пам'ятайте, що в назвах файлів не можна використовувати пробіли.
- Бажано, щоб назви були лаконічними.
- Називати файли найкраще англійськими словами.
Тепер про все це докладніше.
Латинські літери в назві
У назві файлів використовуйте тільки латинські літери. Може здатися, що називати файли українською зручніше та зрозуміліше, але це може викликати технічні проблеми: не всі програми та сервіси коректно сприймають кирилицю.
Зверніть увагу, что використовувати можна тільки нижній регістр літер (тобто маленькі букви). Це пов'язано з тим, що, на відміну від ОС Windows, серверні ОС чутливі до регістру, і там файли index.html і Index.html можуть існувати незалежно один від одного. Таким чином, використання різних регістрів в назвах може призвести до плутанини або втрати даних.
Крім букв, можна також використовувати цифри та деякі інші символи — про це поговоримо нижче.
Неправильно
- корзина.html
- стандартний.css
- Banner1.png
Правильно
- cart.html
- standard.css
- banner1.png
Осмислені назви
Намагайтеся завжди давати файлам такі назви, щоб ви потім могли зрозуміти, що це таке. Уявіть собі, що вам доведеться на місяць-другий переключитися на інші завдання, а потім знову повернутися до проєкту. Або що до вашої команди приєднається нова людина. Якщо назви файлів осмислені, це заощадить купу часу на занурення в роботу.
Неправильно
- 1.html
- new.html
- untitled-copy1.png
Правильно
- main.html
- team.html
- logo.png
Відокремлення слів в назві
Якщо назва файлу складається з декількох слів, треба зробити так, щоб було зрозуміло, де яке. Для цього є три основних способи:
- розділяти слова дефісами,
- розділяти слова нижнім підкресленням,
- починати кожне слово з великої літери.
Дефіси між словами (kebab-case)
Цей принцип ще називають kebab-case — на честь східної страви люля-кебаб, в якому всі інгредієнти нанизують на паличку. Назви, що складені за цим принципом, трохи схожі на люля-кебаб:
first-visit-page.html
Нижнє підкреслення між словами (snake_case)
Цей принцип дуже схожий на попередній — тільки слова поділяють не дефісами, а нижнім підкресленням. Виходить щось схоже на змію, що повзе. Тому цей принцип часто називають snake_case.
first_visit_page.html
Кожне слово з великої літери (CamelCase)
Альтернативний принцип називається CamelCase, тобто «ВерблюжийРегістр». Верблюжим він називається тому, що дві великі літери в слові трохи схожі на верблюжі горби:
FirstPage.html
На практиці застосовуються всі ці підходи, але для курсу ми пропонуємо використовувати саме kebab-case. Просто для дотримання порядку.
Неправильно
- verticallogo.png
- jumpingball.gif
- howtoinstall.html
Правильно
- vertical-logo.png
- jumping-ball.gif
- how-to-install.html
Без пробілів
Для відокремлення слів в назві не варто використовувати пробіли. Як і кириличні символи, вони можуть викликати технічні проблеми: далеко не завжди пробіли коректно розпізнаються.
Неправильно
- vertical logo.png
- jumping ball.gif
- how to install.html
Правильно
- vertical-logo.png
- jumping-ball.aep
- how-to-install.mp4
Лаконічність
Намагаючись давати файлам зрозуміліші назви, легко перегнути палицю. Занадто довгі та докладні назви теж незручні: їх довго читати, і до того ж іноді інтерфейси їх обрізають, так що ви бачите тільки початок. Намагайтеся вмістити назву в 15-20 символів.
Неправильно
- vertical-logo-on-the-black-background.png
- first-project-for-the-ALV-company.html
- ball-jumping-along-the-street.gif
Правильно
- vertical-logo-black.png
- ALV-1.html
- jumping-ball.gif
Назви англійською мовою
Англійська мова є стандартом в програмуванні, тому її варто використовувати і для назв файлів. Крім того, англійська мова лаконічніша і слова в ній зазвичай коротші, ніж в українській. Тож, це допоможе вам дотримуватися й попереднього правила.
Неправильно
- vertikalny-logotip.png
- myachik-skache.gif
- domashne-zavdannya-1.html
Правильно
- vertical-logo.png
- jumping-ball.gif
- task-1.html
