Poboljšajte čitljivost i mogućnost održavanja svog JavaScript koda slijedeći ove konvencije imenovanja.

Neophodno je održavati jednostavnost, čitljivost i lakoću održavanja u vašem kodu kako biste upravljali složenim JavaScript projektima. Dosljedno pridržavanje konvencija o imenovanju ključ je za postizanje ovog cilja.

Varijable, booleove vrijednosti, funkcije, konstante, klase, komponente, metode, privatne funkcije, globalne varijable i datoteke spadaju među JavaScript elemente koji zahtijevaju dosljedne konvencije imenovanja. Možete poboljšati organizaciju koda i razumijevanje implementacijom standardiziranih konvencija imenovanja u svim tim komponentama, štedeći vrijeme i trud na duge staze.

1. Imenovanje varijabli

U JavaScriptu se podaci pohranjuju u varijablama. Bitno je odabrati opisna imena za varijable koja točno odražavaju njihovu funkciju. Možete, na primjer, zamijeniti Korisničko ime ili ukupna cijena za ime varijable, a ne x.

Dobar način za imenovanje varijabli je sljedeći:

neka ukupna cijena = 100;
neka korisničko ime = "Ivan";
instagram viewer

Poboljšana čitljivost koda može se postići korištenjem opisnih naziva varijabli

2. Imenovanje Boolean

Varijable koje mogu imati samo dvije vrijednosti tj pravi ili lažno, poznati su kao Boolean. Ključno je odabrati odgovarajuća imena za boolean varijable koja izražavaju njihovu svrhu.

Za ilustraciju, umjesto odabira naziva varijable kao što je je istina, radije biste išli s isValid ili hasValue.

Razmotrite ovaj primjer:

neka isValid = pravi;
neka hasValue = lažno;

U ovom primjeru, opisna imena Booleovih varijabli jasno pokazuju što predstavljaju.

3. Funkcije imenovanja

Funkcija u JavaScriptu odnosi se na samostalnu jedinicu koda koja je namijenjena za obavljanje određenog zadatka. To je blok koda koji mogu pozivati ​​ili pozivati ​​drugi dijelovi koda i radi kao neovisna cjelina.

Za učinkovito imenovanje funkcija koristite opisna imena koja prenose njihovu svrhu. Na primjer, umjesto stvaranje funkcijefuj, odlučite se za ilustrativnija imena poput validateUserInput ili izračunati ukupnu cijenu.

Na primjer:

funkcijaizračunati ukupnu cijenu(cijena, količina) {
povratak cijena * količina;
}
funkcijavalidateUserInput(ulazni) {
povratak unos !== nedefiniran && unos !== ništavan;
}

4. Imenovanje konstanti

Konstante su varijable koje se ne mogu ponovno dodijeliti. Kada imenujete konstante, važno je koristiti sva velika slova i podvlake za odvajanje riječi.

Na primjer:

konst MAX_PRICE = 1000;
konst MIN_PRICE = 0;

U ovom su primjeru sva velika slova i podvlake korištene za odvajanje riječi u imenima konstanti.

5. Imenovanje klasa

U JavaScriptu se objekti mogu kreirati pomoću nacrta koji se nazivaju klase. Kako bi se postigla besprijekorna praksa imenovanja, od iznimne je važnosti izvršiti PascalCase, konvenciju imenovanja koja nalaže veliko slovo svake riječi.

Uzmimo, na primjer:

razredaKošarica{
konstruktor(marka, model) {
ovaj.make = napraviti;
ovaj.model = model;
 }
}

U ovom primjeru klasa Košarica je imenovan korištenjem PascalCase, što znači da je prvo slovo svake riječi u nazivu klase veliko, a između riječi nema razmaka ili podvlake.

6. Imenovanje komponenti

Komponente su bitni građevni blokovi u modernom razvoju softvera, posebice u okviri poput Reacta, koji naglašavaju višekratni kod.

Rastavljanjem složenog korisničkog sučelja ili aplikacije na manje dijelove kojima se može upravljati, možete stvoriti komponente koje se mogu ponovno koristiti u različitim projektima, smanjujući vrijeme razvoja i povećavajući kod učinkovitost.

Opet, toplo preporučujemo korištenje PascalCase konvencije imenovanja za imenovanje komponenti. To znači pisanje prvog slova svake riječi u nazivu komponente velikim slovom.

Takva konvencija vam pomaže u razlikovanju komponenti od ostalih segmenata koda, pojednostavljujući identifikaciju i manipulaciju.

funkcijaDugme(rekviziti) {
povratak<dugme>{props.label}dugme>;
}

U ovom primjeru, PascalCase konvencija imenovanja korištena je za imenovanje komponente Dugme.

7. Metode imenovanja

Prilikom imenovanja metoda, ključno je koristiti opisna imena koja uspješno komuniciraju što metoda postiže budući da su metode funkcije koje se odnose na objekt.

Na primjer:

razredaAutomobil{
konstruktor(marka, model) {
ovaj.make = napraviti;
ovaj.model = model;
 }
 startEngine() {
// kod za pokretanje motora 
 } 
 stopEngine() { 
// kod za zaustavljanje motora 
 }
 }
}

Opisna imena (startEngine, stopEngine) koriste se za metode u ovom primjeru, osiguravajući lako razumijevanje njihove namjene.

8. Imenovanje privatnih funkcija

Funkcije definirane kao privatne ograničene su na pristup samo unutar objekta u kojem su definirane. Ključno je dodati glavnu podvlaku (_) kako bi označili da su funkcije privatne.

Evo primjera:

razredaAutomobil{
konstruktor(marka, model) {
ovaj.make = napraviti;
ovaj.model = model;
 }
 _startEngine() {
// kod za pokretanje motora
 }
 _stopEngine() {
// kod za zaustavljanje motora
 }
}

Korištenjem podvlake na početku u ovom primjeru, naznačeno je da su funkcije privatne.

9. Imenovanje globalnih varijabli

Varijablama koje su klasificirane kao globalne može se pristupiti iz bilo kojeg dijela baze koda. Prilikom imenovanja takvih globalnih varijabli, ključno je koristiti jasna i opisna imena koja učinkovito prenose njihovu namjenu.

Na primjer:

konst MAX_PRICE = 1000;
konst MIN_PRICE = 0;
funkcijacheckPrice(cijena) {
ako (cijena > MAX_PRICE) {
// kod za rukovanje visokim cijenama
 } drugoako (cijena < MIN_PRICE) {
// kod za rukovanje niskim cijenama
 }
}

10. Imenovanje datoteka

Učinkovita organizacija datoteka ključni je aspekt uspješnog upravljanja JavaScript projektima. Kako bi se osigurale pojednostavljene i dosljedne konvencije imenovanja, bitno je odvajati riječi unutar naziva datoteka malim slovima i crticama.

Poželjna su mala slova jer je JavaScript jezik koji razlikuje velika i mala slova, što znači da jezik različito tretira mala i velika slova. Korištenje malih slova za nazive datoteka osigurava dosljednost i izbjegava zabunu prilikom referenciranja datoteka u kodu.

Crtice se koriste za odvajanje riječi u nazivima datoteka jer razmaci nisu dopušteni u nazivima datoteka. Mogu se koristiti i druge alternative kao što su podvlake ili velika i velika slova, ali crtice su općenito poželjnije zbog njihove čitljivosti.

Korištenje crtica također čini nazive datoteka pristupačnijim za korisnike s čitačima zaslona ili drugim pomoćnim tehnologijama.

moja aplikacija/
├── src/
 ├── komponente/
 ├── gumb.js
 ├── polje za unos.js
├── utils/
 ├── string-utils.js
 ├── date-utils.js
├── app.js
├── index.js

U ovom primjeru, mala slova i crtice koriste se za odvajanje riječi u nazivima datoteka.

Važnost poštivanja konvencija o imenovanju u JavaScriptu

Slijeđenje dobrih konvencija imenovanja bitan je aspekt pisanja čistog koda koji se može održavati u JavaScriptu. Slijedeći ove konvencije, svoj kod možete učiniti čitljivijim i lakšim za održavanje, osobito u nekima JavaScript okviri u kojima morate rukovati glomaznim kodom, što vam može uštedjeti vrijeme i trud u dugoročno gledano.