9 угод, що збивають з пантелику, про іменування

Освойте безкоштовно найпростіший, швидкий і гнучкий спосіб створювати адаптивні веб-сайти.

Дизайн лендінгу

Створюйте дизайн будь-яких сайтів - для себе та на замовлення!

9 угод, що збивають з пантелику, про іменування

Коли Ви тільки починаєте освоюватиРізні мови у світі веб-розробки, то дуже важко відразу запам'ятати всі угоди про ім'я, які в них прийняті.

Ще більша плутанина виникає, якщо досвідчені розробники самі не можуть домовитися про те, що вважати "найкращою практикою".

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

1. Нижнє підкреслення перед ім'ям властивості

Коли Ви бачите, що змінна або метод мають префікс "_", знайте, що тут немає прихованої магії вуду. Це просто угоду про ім'я, яке нагадує розробнику про те, що змінна (властивість) або метод є абоprivate, абоprotected, і до них не можна отримати доступ з-за меж класу.

Зауважте, що в коді вище нижнє підкреслення - це не те, що перетворює властивість або метод наprivateабоprotected; для цього використовуються відповідні специфікатори доступу:privateтаprotected. Нижнє підкреслення - це просто нагадування для Вас, щоб за півроку Вам було простіше орієнтуватися.

Роблячи об'єктFemaleрівним не функції, а об'єкту, що повертається, ми можемо створюватиprivate-змінні. Знову ж таки, нижнє підкреслення нагадує нам про це.

2. ВЕРХНЕРЕЄСТРОВІ константи

Константа – це змінна з незмінним значенням (звучить дивно, але це так:))

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

3. Префікси з однієї літери

Ви напевно десьвже бачили змінну, перед іменем якої стояла одна буква, наприклад, "s" чи "i".

Це називається "Угорська нотація", яка значною мірою втратила свою популярність, хоча все ще застосовується досить часто.

"Угорська нотація" - це угода, яка нагадує розробнику про те, з яким типом даних він працює: рядок, ціле число і т.д.

Чому це важливо?

Уявіть, що ми, використовуючи вищеописану угоду, оголосили змінну для зберігання рядкових даних, використовуючи префікс "s". Після цього ми вирішили змінити значення змінної на число.

Як Ви розумієте, у цьому випадку використання цієї угоди тільки введе нас в оману, але ніяк не допоможе.

Для тих, хто використовує jQuery: Перш ніж Ви застрибнете на п'єдестал пошани, радіючи, що не використовуєте цю угоду, запитайте себе, чи Ви символ долара для змінних всередині об'єкта jQuery?

Якщо так, то це якраз форма Угорської нотації. Це символ, який передує ім'я змінної і служить виключно для того, щоб забезпечити Вас інформацією про змінну.

Чи використовувати його?

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

Я, наприклад, близько року тому відмовився від використання символу долара, але тільки тому, що усвідомив, що він мені не потрібний. Так що просто сформуйте свою власну думку щодо цього.

4. Велика Перша Буква

Як щодо тих імен "змінних", у яких капіталізується перша літера?

У коді вище змінна$SomeClassкапіталізована оскільки це ім'я класу, а чи не ім'я змінної. Знов-таки, цеугоду про іменування, яку дотримуються більшість розробників.

При поверненні до коду через рік Ви легко зможете зрозуміти, що Ви маєте справу з класом, який має об'єкти та методи.

Навіщо ми капіталізуємо ім'я об'єктаPerson?

5. ВерблюжжяНотація проти нижнього_підкреслення

Чому в одних випадках ми бачимо використання верблюжої нотації, а в інших – нижнього підкреслення для поділу слів? Який підхід є правильним?

Відповідь:немає правильного підходу. Це цілком залежить від мови та від стандартів кодування, яких дотримується будь-яка організація чи людина. Обидва варіанти прийнятні.

"Не так важливо, що Ви використовуєте, як те, щоб Ви дотримувалися цього!"

6. Структура папок

Важливість організації структури папок особливо очевидна під час роботи у команді. Але принаймні не варто накидати всі ваші стильові файли та скрипти в одну купу в корінь сайту.

Багато розробників воліють поміщати всі картинки, скрипти та стильові файли в папку з ім'ямAssets.

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

При створенні розмітки, сподіваюся, це всім зрозуміло, ідентифікатори та класи, які ви обираєте, повинні описувати тип вмісту, а не презентаційні аспекти (особливості позиціонування та зовнішнього вигляду). Приклад:

Що буде, якщо через півроку Ви захочете помістити вашого Джастіна Бібера в секцію? У цьому випадку ім'я вашого класу буде дивним.

"З поступовим переходом на HTML5 Вам слід всеменше використовувати ідентифікатори для елементів. Ідентифікатори не дуже гнучкі і, у багатьох випадках, необов'язкові. "

8. Подвійні Хедери та Футери

Згадайте. Коли Ви створюєте сайт із центрованим дизайном, у якого має бути кілька фонів, які займають всю доступну ширину екрану (зазвичай для хедера та футера), Ви зазвичай створюєте "обгортку" для зони контенту, щоб зовнішні елементи могли розширюватися, тоді як внутрішній елемент залишався б центрованим.

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

Труднощі в тому, що, маючи на увазі, що ми працюємо з новими елементами HTML5, нам потрібно вирішити, чи поміщати елемент футер всередині або зовні. Це все ще предмет дискусій, проте я схильний вважати, що більш семанічно грамотно поміщати реальний футер усередину.

Елементиdivслід використовувати тільки, якщо:

- немає більш відповідного елемента для конкретного завдання - вам потрібен елемент виключно для структурування макета сторінки

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

Саме тому дуже важливо, щоб усі в команді розробників дотримувалися одного і того ж стандарту кодування. Розглянемо кілька прикладів:

А Ви товаришуєте з тернарним оператором?

Як щодо логічного && для умов?

Багато розробників побояться використовувати в цьому випадку логічнеІ, наполягаючи на тому, що це знижує читабельність коду. Це, зрозуміло, вагомий аргумент, хоча, незважаючи на це, навіть популярні бібліотеки, на зразок jQuery, активно застосовують цей прийом.

Як ужезгадувалося, не так важливо, яких угод Ви дотримуєтеся. Головне, щоб Ви їх дотримувалися і не допускали "змішування стилів". Насправді, деякі команди розробників виробляють свої власні угоди під час роботи над проектами.

За матеріалами net.tutsplus.com Переклад - Дмитро Науменко

9 угод, що збивають з пантелику, про іменування

Дизайн лендінгу

Популярне

9 угод, що збивають з пантелику, про іменування