10 основни конвенции за именуване на JavaScript, които всеки програмист трябва да знае

От съществено значение е да поддържате простота, четливост и лекота на поддръжка във вашия код, за да управлявате сложни JavaScript проекти. Постоянното спазване на конвенциите за именуване е ключът към постигането на тази цел.

Променливи, булеви, функции, константи, класове, компоненти, методи, частни функции, глобални променливи и файлове са сред елементите на JavaScript, които изискват последователни конвенции за именуване. Можете да подобрите организацията и разбирането на кода чрез прилагане на стандартизирани конвенции за именуване във всички тези компоненти, спестявайки време и усилия в дългосрочен план.

1. Наименуване на променливи

В JavaScript данните се съхраняват в променливи. Важно е да изберете описателни имена за променливите, които отразяват точно тяхната функция. Бихте могли например да замените потребителско име или обща цена за името на променлива, а не х.

Добър начин за именуване на променливи е както следва:

позволявам обща цена = 100;
позволявам потребителско име = "Джон";

Подобрена четимост на кода може да се постигне чрез използване на описателни имена на променливи

2. Наименуване Boolean

Променливи, които могат да имат само две стойности, т.е вярно или невярно, са известни като булеви. От решаващо значение е да изберете подходящи имена за булеви променливи, които изразяват тяхната цел.

За илюстрация, вместо да изберете име на променлива като истина е, трябва да предпочетете да отидете с е валиден или hasValue.

Помислете за този пример:

позволявам isValid = вярно;
позволявам hasValue = невярно;

В този пример описателните булеви имена на променливи показват ясно какво представляват.

3. Функции за именуване

Функция в JavaScript се отнася до самостоятелна единица код, която е предназначена да изпълни определена задача. Това е блок от код, който може да бъде извикан или извикан от други части на кода и работи като независим обект.

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

Например:

функцияизчисли общата цена(цена, количество) {
връщане цена * количество;
}
функцияvalidateUserInput(вход) {
връщане въвеждане !== недефиниран && въвеждане !== нула;
}

4. Константи за именуване

Константите са променливи, които не могат да бъдат преназначавани. Когато именувате константи, е важно да използвате всички главни букви и долна черта за разделяне на думите.

Например:

конст MAX_PRICE = 1000;
конст MIN_PRICE = 0;

В този пример всички главни букви и долни черти са използвани за разделяне на думи в имената на константите.

5. Именуване на класове

В JavaScript обектите могат да се създават с помощта на чертежи, наречени класове. За постигане на безупречни практики за именуване е от изключителна важност да се изпълни PascalCase, конвенция за именуване, която изисква главната буква на всяка дума.

Вземете например:

класКарта за пазаруване{
конструктор(марка, модел) {
това.make = направи;
това.model = модел;
 }
}

В този пример класът Карта за пазаруване е наименуван с помощта на PascalCase, което означава, че първата буква на всяка дума в името на класа е главна и няма интервали или долна черта между думите.

6. Наименуване на компоненти

Компонентите са основни градивни елементи в съвременната разработка на софтуер, особено в рамки като React, които подчертават многократно използваемия код.

Като разделите сложен потребителски интерфейс или приложение на по-малки, управляеми парчета, можете да създадете компоненти, които могат да се използват повторно в различни проекти, намалявайки времето за разработка и увеличавайки кода ефективност.

Отново силно препоръчваме използването на конвенцията за именуване на PascalCase за именуване на компоненти. Това означава главна първа буква на всяка дума в името на компонента.

Такава конвенция ви помага да разграничите компонентите от други кодови сегменти, опростявайки идентификацията и манипулирането.

функцияБутон(реквизит) {
връщане<бутон>{props.label}бутон>;
}

В този пример за именуване на компонента е използвана конвенцията за именуване PascalCase Бутон.

7. Методи за именуване

Когато именувате методи, е изключително важно да използвате описателни имена, които успешно съобщават какво постига методът, тъй като методите са функции, които се отнасят до обект.

Например:

класКола{
конструктор(марка, модел) {
това.make = направи;
това.model = модел;
 }
 startEngine() {
// код за стартиране на двигателя 
 } 
 stopEngine() { 
// код за спиране на двигателя 
 }
 }
}

Описателни имена (startEngine, stopEngine) се използват за методите в този пример, като се гарантира, че предназначението им е лесно разбираемо.

8. Наименуване на частни функции

Функциите, дефинирани като частни, са ограничени за достъп само в рамките на обекта, където са дефинирани. От решаващо значение е да добавите долна черта (_), за да укажете, че функциите са лични.

Ето един пример:

класКола{
конструктор(марка, модел) {
това.make = направи;
това.model = модел;
 }
 _startEngine() {
// код за стартиране на двигателя
 }
 _stopEngine() {
// код за спиране на двигателя
 }
}

Чрез използване на долна черта в началото в този пример се посочва, че функциите са лични.

9. Наименуване на глобални променливи

Променливите, които са класифицирани като глобални, могат да бъдат достъпни от всяка част на кодовата база. Докато именувате такива глобални променливи, е изключително важно да използвате ясни и описателни имена, които ефективно предават предназначението им.

Например:

конст MAX_PRICE = 1000;
конст MIN_PRICE = 0;
функцияcheckPrice(цена) {
ако (цена > MAX_PRICE) {
// код за обработка на високи цени
 } другоако (цена < MIN_PRICE) {
// код за обработка на ниски цени
 }
}

10. Именуване на файлове

Ефективната файлова организация е решаващ аспект от успешното управление на JavaScript проекти. За да се осигурят рационализирани и последователни конвенции за именуване, от съществено значение е думите в имената на файлове да се разделят с малки букви и тирета.

Предпочитат се малките букви, тъй като JavaScript е език, чувствителен към малки и големи букви, което означава, че езикът третира малките и главните букви по различен начин. Използването на малки букви за имена на файлове гарантира последователност и избягва объркване при препращане към файлове в кода.

Тиретата се използват за разделяне на думи в имената на файлове, тъй като интервалите не са разрешени в имената на файловете. Могат да се използват и други алтернативи като долни черти или главни и главни букви, но тиретата обикновено се предпочитат за тяхната четливост.

Използването на тирета също прави имената на файловете по-достъпни за потребители с екранни четци или други помощни технологии.

моето приложение/
├── src/
 ├── компоненти/
 ├── button.js
 ├── input-field.js
├── utils/
 ├── string-utils.js
 ├── date-utils.js
├── app.js
├── index.js

В този пример малки букви и тирета се използват за разделяне на думи в имената на файловете.

Важно е да се следват конвенциите за именуване в JavaScript

Следването на добрите конвенции за именуване е съществен аспект от писането на чист и поддържаем код в JavaScript. Като следвате тези конвенции, можете да направите кода си по-четлив и поддържаем, особено в някои JavaScript рамки, където от вас се изисква да боравите с обемен код, което може да ви спести време и усилия в дълго бягане.