Pagerinkite savo „JavaScript“ kodo skaitomumą ir priežiūrą laikydamiesi šių pavadinimų suteikimo taisyklių.

Norint valdyti sudėtingus „JavaScript“ projektus, būtina išlaikyti kodo paprastumą, skaitomumą ir lengvą priežiūrą. Norint pasiekti šį tikslą, labai svarbu nuosekliai laikytis pavadinimų konvencijų.

Kintamieji, loginiai parametrai, funkcijos, konstantos, klasės, komponentai, metodai, privačios funkcijos, visuotiniai kintamieji ir failai yra tarp „JavaScript“ elementų, kuriems reikia nuoseklių pavadinimų suteikimo. Galite pagerinti kodo organizavimą ir supratimą įdiegę standartizuotas pavadinimų suteikimo taisykles visuose šiuose komponentuose, sutaupydami laiko ir pastangų ilgainiui.

1. Kintamųjų įvardijimas

„JavaScript“ programoje duomenys saugomi kintamuosiuose. Labai svarbu pasirinkti aprašomuosius kintamųjų pavadinimus, kurie tiksliai atspindėtų jų funkciją. Pavyzdžiui, galite jį pakeisti Vartotojo vardas arba Bendra kaina kintamojo pavadinimui, o ne x.

Geras būdas pavadinti kintamuosius yra toks:

instagram viewer 
leisti bendra kaina = 100;
leisti vartotojo vardas = "Jonas";

Patobulintas kodo skaitomumas gali būti pasiektas naudojant aprašomuosius kintamųjų pavadinimus

2. Būlio pavadinimas

Kintamieji, kurie gali turėti tik dvi reikšmes, t. y. arba tiesa arba klaidinga, yra žinomi kaip Būlio. Labai svarbu pasirinkti tinkamus loginių kintamųjų pavadinimus, kurie išreiškia jų paskirtį.

Norėdami iliustruoti, užuot pasirinkę kintamojo pavadinimą, pvz tiesa, jūs turėtumėte pirmenybę eiti su galiojantis arba hasValue.

Apsvarstykite šį atvejį:

leisti galioja = tiesa;
leisti hasValue = klaidinga;

Šiame pavyzdyje aprašomieji loginiai kintamųjų pavadinimai aiškiai parodo, ką jie atstovauja.

3. Funkcijų įvardijimas

„JavaScript“ funkcija reiškia savarankišką kodo vienetą, skirtą tam tikrai užduočiai atlikti. Tai yra kodo blokas, kurį gali iškviesti arba iškviesti kitos kodo dalys ir kuris veikia kaip nepriklausomas subjektas.

Norėdami efektyviai pavadinti funkcijas, naudokite aprašomuosius pavadinimus, nurodančius jų paskirtį. Pavyzdžiui, vietoj sukurti funkcijąfoo, pasirinkite labiau iliustruojančius pavadinimus, pvz valideUserInput arba apskaičiuoti TotalPrice.

Pavyzdžiui:

funkcijaapskaičiuoti TotalPrice(kaina, kiekis) {
grąžinti kaina * kiekis;
}
funkcijavalideUserInput(įvestis) {
grąžinti įvestis !== neapibrėžtas && įvestis !== nulinis;
}

4. Konstantų įvardijimas

Konstantos yra kintamieji, kurių negalima priskirti iš naujo. Vardinant konstantas, svarbu atskirti žodžius didžiosiomis raidėmis ir apatiniais brūkšniais.

Pavyzdžiui:

konst MAX_PRICE = 1000;
konst MIN_PRICE = 0;

Šiame pavyzdyje visos didžiosios raidės ir apatiniai brūkšniai buvo naudojami žodžiams atskirti pastovių pavadinimuose.

5. Klasių įvardijimas

JavaScript, objektus galima sukurti naudojant brėžinius, vadinamus klasėmis. Norint pasiekti nepriekaištingą pavadinimų suteikimo praktiką, labai svarbu vykdyti PascalCase – pavadinimų suteikimo tvarką, kuri įpareigoja kiekvieno žodžio pirmąją raidę rašyti didžiosiomis raidėmis.

Paimkite, pavyzdžiui:

klasėPrekių krepšelis{
konstruktorius(markė, modelis) {
tai.make = padaryti;
tai.modelis = modelis;
 }
}

Šiame pavyzdyje klasė Prekių krepšelis buvo pavadintas naudojant „PascalCase“, o tai reiškia, kad kiekvieno žodžio pirmoji raidė klasės pavadinime rašoma didžiosiomis raidėmis ir tarp žodžių nėra tarpų ar apatinių brūkšnių.

6. Komponentų įvardijimas

Komponentai yra esminiai šiuolaikinės programinės įrangos kūrimo elementai, ypač tokios sistemos kaip „React“., kuriuose pabrėžiamas daugkartinio naudojimo kodas.

Suskaidydami sudėtingą vartotojo sąsają ar programą į mažesnes, valdomas dalis, galite sukurti komponentai, kuriuos galima pakartotinai naudoti įvairiuose projektuose, sumažinant kūrimo laiką ir padidinant kodą efektyvumą.

Vėlgi, mes primygtinai rekomenduojame naudoti PascalCase pavadinimų suteikimo susitarimą komponentams pavadinti. Tai reiškia, kad komponento pavadinime kiekvieno žodžio pirmoji raidė rašoma didžiosiomis raidėmis.

Toks susitarimas padeda atskirti komponentus nuo kitų kodo segmentų, supaprastina identifikavimą ir manipuliavimą.

funkcijaMygtukas(rekvizitai) {
grąžinti<mygtuką>{props.label}mygtuką>;
}

Šiame pavyzdyje komponentui pavadinti buvo naudojama „PascalCase“ pavadinimų sutartis Mygtukas.

7. Vardų suteikimo metodai

Suteikiant metodus pavadinimus, labai svarbu naudoti aprašomuosius pavadinimus, kurie sėkmingai perteiktų metodo rezultatus, nes metodai yra funkcijos, susijusios su objektu.

Pavyzdžiui:

klasėAutomobilis{
konstruktorius(markė, modelis) {
tai.make = padaryti;
tai.modelis = modelis;
 }
 startEngine() {
// kodas variklio paleidimui 
 } 
 stopEngine() { 
// kodas variklio sustabdymui 
 }
 }
}

Apibūdinamieji pavadinimai (paleisti Variklį, sustabdytiVariklį) yra naudojami šio pavyzdžio metodams, užtikrinant, kad jų paskirtis būtų lengvai suprantama.

8. Privačių funkcijų įvardijimas

Funkcijos, apibrėžtos kaip privačios, pasiekiamos tik tame objekte, kuriame jos apibrėžtos. Labai svarbu pridėti pabraukimo brūkšnį (_), nurodantį, kad funkcijos yra privačios.

Štai pavyzdys:

klasėAutomobilis{
konstruktorius(markė, modelis) {
tai.make = padaryti;
tai.modelis = modelis;
 }
 _startEngine() {
// kodas variklio paleidimui
 }
 _stopVariklis() {
// kodas variklio sustabdymui
 }
}

Šiame pavyzdyje naudojant pagrindinį pabraukimą, nurodoma, kad funkcijos yra privačios.

9. Pasaulinių kintamųjų įvardijimas

Kintamuosius, kurie yra klasifikuojami kaip visuotiniai, galima pasiekti iš bet kurios kodo bazės dalies. Vardinant tokius visuotinius kintamuosius, labai svarbu naudoti aiškius ir aprašomus pavadinimus, kurie veiksmingai perteiktų jų paskirtį.

Pavyzdžiui:

konst MAX_PRICE = 1000;
konst MIN_PRICE = 0;
funkcijapatikrinti Kaina(kaina) {
jeigu (kaina > MAX_PRICE) {
// kodas aukštoms kainoms tvarkyti
 } Kitasjeigu (kaina < MIN_PRICE) {
// kodas žemoms kainoms tvarkyti
 }
}

10. Failų pavadinimo suteikimas

Veiksmingas failų organizavimas yra esminis sėkmingo „JavaScript“ projekto valdymo aspektas. Siekiant užtikrinti supaprastintą ir nuoseklų pavadinimų suteikimo tvarką, labai svarbu atskirti žodžius failų pavadinimuose mažosiomis raidėmis ir brūkšneliais.

Pirmenybė teikiama mažosioms raidėms, nes „JavaScript“ yra didžiųjų ir mažųjų raidžių kalba, o tai reiškia, kad kalba mažosios ir didžiosios raidės traktuojamos skirtingai. Naudojant mažąsias raides failų pavadinimuose užtikrinamas nuoseklumas ir išvengiama painiavos, kai pateikiamos nuorodos į failus kode.

Brūkšneliai naudojami žodžiams atskirti failų pavadinimuose, nes failų pavadinimuose tarpai neleidžiami. Taip pat gali būti naudojamos kitos alternatyvos, pvz., apatiniai brūkšniai arba „camelCase“, tačiau dažniausiai pirmenybė teikiama brūkšniniams, kad būtų lengviau skaityti.

Be to, naudojant brūkšnelius, failų pavadinimai tampa lengviau pasiekiami vartotojams, turintiems ekrano skaitytuvus ar kitas pagalbines technologijas.

mano programa/
├── src/
 ├── komponentai/
 ├── button.js
 ├── input-field.js
├── utils/
 ├── string-utils.js
 ├── date-utils.js
├── app.js
├── index.js

Šiame pavyzdyje mažosios raidės ir brūkšneliai naudojami žodžiams atskirti failų pavadinimuose.

„JavaScript“ pavadinimų suteikimo taisyklių laikymosi svarba

Gerų pavadinimų suteikimo taisyklių laikymasis yra esminis aspektas rašant švarų ir prižiūrimą kodą „JavaScript“. Laikydamiesi šių taisyklių, galite padaryti savo kodą skaitomesnį ir lengviau prižiūrimą, ypač kai kuriuose „JavaScript“ sistemos, kuriose turite tvarkyti didelį kodą, o tai gali sutaupyti laiko ir pastangų ilgas bėgimas.