Декілька загальноприйнятих угод про іменування
Починаючи працювати з різними мовами програмування у сфері Інтернет розробки, дуже складно запам'ятати всі угоди про назву при переходах від однієї мови до іншої. Особливо, коли веб-розробники не мають спільної думки з приводу того, що вважати кращою практикою програмування. Щоб полегшити життя новачкам, у статті наводяться кілька загальних угод про іменування.
1. Підкреслення перед ім'ям властивості
Якщо розглядати змінні чи методи, імена яких починаються з _ , то складно буде знайти якусь магічну дію, приховану від очей. Це просто угода про іменування, яка служить відмінним нагадуванням розробнику про те, що змінна/властивість/метод оголошений як private або protected, і не доступна поза класом.
Зверніть увагу, що підкреслення у наведеному вище коді НЕ ОГОЛОШУЄ змінну або метод як private . Існує ключові слова private/protected . Підкреслення служить тільки як нагадування (якщо доведеться повернутися до розбору коду через півроку)!
Оголошуючи Female еквівалентної не функції, а об'єкту, що повертається, ми створюємо приватну змінну. Префікс у вигляді підкреслення нагадуватиме про це.
2. КОНСТАНТИ, написані великими літерами
3. Односимвольний префікс
Напевно, вам вже траплялися змінні, імена які починалися з якогось маленького символу, наприклад "s" або "i".
Це так звана угорська нотація, яка втратила свою популярність останніми роками, але все ж є компанії, які її використовують у своїх розробках. Угорська нотація є угодою про найменування, яка призначена для нагадування розробнику про тип змінної, з якою він працює:s tring ,i nteger, і так далі.
Символ долара
Для користувачів jQuery: перш ніж стати на п'єдестал і похвалити себе за невикористання такої угоди про іменування, запитайте себе - чи використовували ви для змінних, значення яких обернено на об'єкт jQuery, символ долара спочатку? Якщо так, то знайте – це форма угорської нотації. Призначення такого префікса полягає в тому, щоб інформувати розробника про властивості змінної.
Чи слід використовувати його?
Відповідь на поставлене запитання залежить від вас. Хоча багато розробників jQuery використовують префікс як символ долара.
4. Перший символ у верхньому регістрі
А як розглядати "змінні", імена яких починаються із символу у верхньому регістрі?
У наведеному вище коді $SomeClass є класом , а не змінною . Ця угода про найменування використовується дуже багатьма програмістами. Коли повертаєшся до роботи з кодом через деякий час, така назва сигналізує, що ім'я використовується для роботи з класом, для якого доступні об'єкти та методи.
В якості альтернативи ви можете створити захист від такої забудькуватості. Потрібно перевірити, чим є конструктор насправді та провести коригування.
5. Поділ Слов заголовними літерами проти використання_підкреслень
Чому в одних випадках використовують поділ слів в іменах змінних за допомогою великих перших літер, а в інших розділяють слова символом підкреслення? Як правильно? Правила повністю залежать від угод у вашій робочій групі. Обидва методи рівнозначні.
6. Структура каталогів
Це питання стає особливо гострим при роботі в команді. У таких умовах просто необхідно мати продуману структуру каталогу проекту. Але навітьпри роботі над невеликими завданнями поодинці не варто складати таблиці стилів і скрипти в одну велику купу в кореневому каталозі без будь-якої організації. Багато розробників вважають за краще розміщувати зображення, скрипти та таблиці стилів у підкаталогах з батьківською директорією Assets (перекладається як "засіб").
Відзначте також наявність папок min , які містять мінімізовані версії ваших скриптів і таблиць стилів, що динамічно додаються.
7. Семантика
При створенні розмітки ваші id та класи повинні описувати тип контенту, але не презентаційні аспекти. Наприклад:
Дуже погано
Найкращий варіант
Чому? Допустимо через шість місяців ви вирішите, що прославляти Васю Пупкіна стоїть у секції, яка розташована трохи-правіше-і-трохи-вище? В даному випадку ваш ID відразу ж втратить сенс.
Поступово ми переходимо у світ HTML5, і використання ідентифікаторів суттєво скорочується, тому що для різних розділів сторінки є стандартні теги.
8. Скорочення
Рішення про використання скорочень у коді завжди приймається на полі битви між легкістю читання та розміром коду. Розглянемо два приклади:
Ви використовуєте тернарний оператор?
Як щодо використання логічного І для скорочення умовних операндів?
Дуже багато розробників косо дивляться на таке використання логічного І, пояснюючи суттєвою втратою легкості читання коду. Хоча це правильний аргумент, проте навіть у jQuery часто використовується даний метод.
Висновок
У статті розглянуто кілька поширених угод найменування, та їх використання є особистою справою кожного. Насправді багато команд розробників пишуть справжні фоліанти за правилами.іменування.
Даний урок підготовлений для вас командою сайту ruseller.com Джерело уроку: net.tutsplus.com/articles/general/9-confusing-naming-conventions-for-beginners/ Переклав: Євген Попов Урок створений : 23 Листопада 2010 Переглядів: 19946 Правила передруку
5 останніх уроків рубрики "Різне"
Як розмістити свій сайт на хостингу? Правильно обраний хороший хостинг – це майбутнє Ваших сайтів
Проект готовий, Все перевірено на локальному сервері OpenServer та можна переносити сайт на хостинг. Ось тільки яку компанію вибрати? Пропоную переглянути хостинг fornex.com. Відмінне місце для твого проекту із перспективами бурхливого зростання.
Розробка веб-сайтів за допомогою онлайн платформи Wrike
Створення вебсайту – процес трудомісткий, що вимагає злагодженої взаємодії між замовником та виконавцем, а також між усіма членами колективу, залученими до проекту. І в цьому дуже хорошу підмогу надасть онлайн платформа Wrike.
20 ресурсів для прототипування
Добірка з кількох десятків ресурсів для створення мокапів та прототипів.
Топ 10 безкоштовних хостингів
Невелика вибірка провайдерів безкоштовного хостингу з детальним описом.
Швидка замітка: масовий UPDATE у MySQL
Ні для кого не секрет як у MySQL реалізувати масовий INSERT, а ось з UPDATE можуть виникнути складності. Щоб не вдаватися до маніпуляцій події ON_DUPLICATE, можна скористатися спеціальною конструкцією CASE … WHEN … THEN.