Izboljšajte berljivost in vzdržljivost kode JavaScript z upoštevanjem teh konvencij o poimenovanju.
Bistvenega pomena je ohraniti preprostost, berljivost in enostavnost vzdrževanja v vaši kodi, da lahko upravljate zapletene projekte JavaScript. Dosledno upoštevanje konvencij o poimenovanju je ključ do doseganja tega cilja.
Spremenljivke, logične vrednosti, funkcije, konstante, razredi, komponente, metode, zasebne funkcije, globalne spremenljivke in datoteke so med elementi JavaScript, ki zahtevajo dosledno poimenovanje. Organizacijo in razumevanje kode lahko izboljšate z implementacijo standardiziranih konvencij o poimenovanju v vseh teh komponentah, kar dolgoročno prihrani čas in trud.
1. Poimenovanje spremenljivk
V JavaScriptu so podatki shranjeni v spremenljivkah. Bistveno je, da za spremenljivke izberete opisna imena, ki natančno odražajo njihovo funkcijo. Lahko bi na primer zamenjali uporabniško ime oz skupna cena za ime spremenljivke namesto x.
Dober način za poimenovanje spremenljivk je naslednji:
pustiti skupna cena = 100;
pustiti uporabniško ime = "Janez";Izboljšano berljivost kode je mogoče doseči z uporabo opisnih imen spremenljivk
2. Poimenovanje Boolean
Spremenljivke, ki imajo lahko samo dve vrednosti, tj prav oz lažno, so znani kot Boolean. Bistveno je, da izberete ustrezna imena za logične spremenljivke, ki izražajo njihov namen.
Za ponazoritev, namesto da bi se odločili za ime spremenljivke, kot je npr je Res, raje pojdite z isValid oz hasValue.
Razmislite o tem primeru:
pustiti isValid = prav;
pustiti hasValue = lažno;V tem primeru opisna imena logičnih spremenljivk pojasnjujejo, kaj predstavljajo.
3. Funkcije poimenovanja
Funkcija v JavaScriptu se nanaša na samostojno enoto kode, ki je namenjena izvajanju določene naloge. Je blok kode, ki ga lahko pokličejo ali prikličejo drugi deli kode in deluje kot neodvisna entiteta.
Za učinkovito poimenovanje funkcij uporabite opisna imena, ki izražajo njihov namen. Na primer, namesto ustvarjanje funkcijefoo, se odločite za bolj nazorna imena, kot validateUserInput oz izračunaSkupnoCeno.
Na primer:
funkcijoizračunaSkupnoCeno(cena, količina) {
vrnitev cena * količina;
}
funkcijovalidateUserInput(vnos) {
vrnitev vnos !== nedoločeno && vnos !== nič;
}
4. Poimenovanje konstant
Konstante so spremenljivke, ki jih ni mogoče ponovno dodeliti. Pri poimenovanju konstant je pomembno, da za ločevanje besed uporabite vse velike črke in podčrtaje.
Na primer:
konst MAX_PRICE = 1000;
konst MIN_PRICE = 0;V tem primeru so bile za ločevanje besed v imenih konstant uporabljene vse velike črke in podčrtaji.
5. Poimenovanje razredov
V JavaScriptu je mogoče objekte ustvariti z uporabo načrtov, imenovanih razredi. Da bi dosegli brezhibno prakso poimenovanja, je izredno pomembno, da izvedete PascalCase, konvencijo o poimenovanju, ki zahteva uporabo velike začetnice vsake besede.
Vzemimo na primer:
razredNakupovalni voziček{
konstruktor(znamka, model) {
to.make = narediti;
to.model = model;
}
}
V tem primeru je razred Nakupovalni voziček je bil poimenovan z uporabo PascalCase, kar pomeni, da je bila prva črka vsake besede v imenu razreda velika in da med besedami ni presledkov ali podčrtajev.
6. Poimenovanje komponent
Komponente so bistveni gradniki sodobnega razvoja programske opreme, zlasti v ogrodja, kot je React, ki poudarjajo kodo za večkratno uporabo.
Če kompleksen uporabniški vmesnik ali aplikacijo razdelite na manjše, obvladljive dele, lahko ustvarite komponente, ki jih je mogoče ponovno uporabiti v različnih projektih, kar skrajša razvojni čas in poveča kodo učinkovitost.
Ponovno zelo priporočamo uporabo konvencije o poimenovanju PascalCase za poimenovanje komponent. To pomeni veliko začetnico vsake besede v imenu komponente.
Takšna konvencija vam pomaga pri razlikovanju komponent od drugih segmentov kode, kar poenostavi identifikacijo in manipulacijo.
funkcijoGumb(rekviziti) {
vrnitev<gumb>{props.label}gumb>;
}V tem primeru je bila za poimenovanje komponente uporabljena konvencija o poimenovanju PascalCase Gumb.
7. Metode poimenovanja
Pri poimenovanju metod je ključnega pomena uporaba opisnih imen, ki uspešno sporočajo, kaj metoda doseže, saj so metode funkcije, ki se nanašajo na objekt.
Na primer:
razredavto{
konstruktor(znamka, model) {
to.make = narediti;
to.model = model;
}
startEngine() {
// koda za zagon motorja
}
stopEngine() {
// koda za zaustavitev motorja
}
}
}
Opisna imena (startEngine, stopEngine) se uporabljajo za metode v tem primeru, kar zagotavlja, da je njihov namen zlahka razumljiv.
8. Poimenovanje zasebnih funkcij
Funkcije, definirane kot zasebne, so omejene na dostop samo znotraj objekta, kjer so definirane. Ključnega pomena je dodati začetni podčrtaj (_), ki označuje, da so funkcije zasebne.
Tukaj je primer:
razredavto{
konstruktor(znamka, model) {
to.make = narediti;
to.model = model;
}
_startEngine() {
// koda za zagon motorja
}
_stopEngine() {
// koda za zaustavitev motorja
}
}
Z uporabo podčrtaja na začetku v tem primeru je označeno, da so funkcije zasebne.
9. Poimenovanje globalnih spremenljivk
Do spremenljivk, ki so razvrščene kot globalne, je mogoče dostopati iz katerega koli dela kodne baze. Pri poimenovanju takšnih globalnih spremenljivk je ključnega pomena uporaba jasnih in opisnih imen, ki učinkovito izražajo njihov namen.
Na primer:
konst MAX_PRICE = 1000;
konst MIN_PRICE = 0;
funkcijocheckPrice(cena) {
če (cena > MAX_PRICE) {
// koda za obvladovanje visokih cen
} drugačeče (cena < MIN_PRICE) {
// koda za obravnavo nizkih cen
}
}
10. Poimenovanje datotek
Učinkovita organizacija datotek je ključni vidik uspešnega upravljanja projektov JavaScript. Da bi zagotovili poenostavljene in dosledne konvencije poimenovanja, je nujno, da ločite besede v imenih datotek z malimi črkami in vezaji.
Zaželene so male črke, ker je JavaScript jezik, ki razlikuje velike in male črke, kar pomeni, da jezik male in velike črke obravnava drugače. Uporaba malih črk za imena datotek zagotavlja doslednost in preprečuje zmedo pri sklicevanju na datoteke v kodi.
Vezaji se uporabljajo za ločevanje besed v imenih datotek, ker presledki v imenih datotek niso dovoljeni. Uporabijo se lahko tudi druge možnosti, kot so podčrtaji ali velike in male črke, vendar so na splošno prednostni vezaji zaradi njihove berljivosti.
Uporaba vezajev tudi naredi imena datotek bolj dostopna za uporabnike z bralniki zaslona ali drugimi podpornimi tehnologijami.
moja aplikacija/
├── src/
├── komponente/
├── gumb.js
├── vnosno-polje.js
├── pripomočki/
├── string-utils.js
├── date-utils.js
├── app.js
├── index.jsV tem primeru se za ločevanje besed v imenih datotek uporabljajo male črke in vezaji.
Pomembnost upoštevanja konvencij o poimenovanju v JavaScriptu
Upoštevanje dobrih konvencij o poimenovanju je bistveni vidik pisanja čiste in vzdržljive kode v JavaScriptu. Z upoštevanjem teh konvencij lahko naredite svojo kodo bolj berljivo in vzdržljivo, zlasti v nekaterih Ogrodja JavaScript, kjer morate obravnavati obsežno kodo, kar vam lahko prihrani čas in trud pri dolgi rok.