Zlepšite čitateľnosť a udržiavateľnosť kódu JavaScript dodržiavaním týchto konvencií pomenovania.
Aby ste mohli spravovať zložité projekty JavaScriptu, je nevyhnutné zachovať jednoduchosť, čitateľnosť a jednoduchosť údržby vo vašom kóde. Kľúčom k dosiahnutiu tohto cieľa je dôsledné dodržiavanie konvencií o názvoch.
Premenné, boolovské hodnoty, funkcie, konštanty, triedy, komponenty, metódy, súkromné funkcie, globálne premenné a súbory patria medzi prvky JavaScriptu, ktoré vyžadujú konzistentné konvencie pomenovania. Organizáciu kódu a jeho porozumenie môžete zlepšiť implementáciou štandardizovaných konvencií pomenovania vo všetkých týchto komponentoch, čo z dlhodobého hľadiska ušetrí čas a námahu.
1. Pomenovanie premenných
V JavaScripte sú dáta uložené v premenných. Je nevyhnutné zvoliť popisné názvy premenných, ktoré presne odrážajú ich funkciu. Môžete napríklad nahradiť užívateľské meno alebo Celková cena namiesto názvu premennej X.
Dobrý spôsob, ako pomenovať premenné, je nasledujúci:
nech celková cena = 100;
nech užívateľské meno = "John";Lepšiu čitateľnosť kódu je možné dosiahnuť použitím popisných názvov premenných
2. Pomenovanie Boolean
Premenné, ktoré môžu mať iba dve hodnoty, t.j pravda alebo falošný, sú známe ako Boolean. Je dôležité zvoliť vhodné názvy pre booleovské premenné, ktoré vyjadrujú ich účel.
Pre ilustráciu, namiesto výberu názvu premennej ako napr je pravda, mali by ste ísť radšej s je platné alebo hasValue.
Zvážte tento prípad:
nech isValid = pravda;
nech hasValue = falošný;V tomto príklade popisné názvy booleovských premenných objasňujú, čo predstavujú.
3. Funkcie pomenovania
Funkcia v JavaScripte označuje samostatnú jednotku kódu, ktorá je určená na vykonávanie konkrétnej úlohy. Je to blok kódu, ktorý možno volať alebo vyvolať inými časťami kódu a funguje ako nezávislá entita.
Na efektívne pomenovanie funkcií používajte popisné názvy, ktoré vyjadrujú ich účel. Napríklad namiesto toho vytvorenie funkciefoo, rozhodnite sa pre názornejšie názvy ako validateUserInput alebo vypočítaťCelkovú cenu.
Napríklad:
funkciuvypočítaťCelkovú cenu(cena, množstvo) {
vrátiť cena * množstvo;
}
funkciuvalidateUserInput(vstup) {
vrátiť vstup !== nedefinované && vstup !== nulový;
}
4. Konštanty pomenovania
Konštanty sú premenné, ktoré nie je možné opätovne priradiť. Pri pomenovaní konštánt je dôležité používať na oddelenie slov všetky veľké písmená a podčiarkovníky.
Napríklad:
konšt MAX_PRICE = 1000;
konšt MIN_PRICE = 0;V tomto príklade boli na oddelenie slov v názvoch konštanty použité všetky veľké písmená a podčiarkovníky.
5. Pomenovanie tried
V JavaScripte možno objekty vytvárať pomocou plánov nazývaných triedy. Na dosiahnutie bezchybných praktík pomenovávania je nanajvýš dôležité spustiť PascalCase, konvenciu pomenovávania, ktorá nariaďuje písanie veľkých písmen v prvom písmene každého slova.
Vezmite si napríklad:
triedaNákupný vozík{
konštruktér(značka, model) {
toto.make = robiť;
toto.modelka = modelka;
}
}
V tomto príklade trieda Nákupný vozík bola pomenovaná pomocou PascalCase, čo znamená, že prvé písmeno každého slova v názve triedy bolo veľké a medzi slovami nie sú žiadne medzery ani podčiarkovníky.
6. Pomenovanie komponentov
Komponenty sú základnými stavebnými kameňmi moderného vývoja softvéru, najmä v rámce ako React, ktoré zdôrazňujú opakovane použiteľný kód.
Rozdelením zložitého používateľského rozhrania alebo aplikácie na menšie, spravovateľné časti môžete vytvárať komponenty, ktoré možno opätovne použiť v rôznych projektoch, čím sa skracuje čas vývoja a zvyšuje sa kód efektívnosť.
Opäť dôrazne odporúčame používať na pomenovanie komponentov konvenciu pomenovania PascalCase. To znamená, že prvé písmeno každého slova v názve komponentu sa napíše na veľké.
Takáto konvencia vám pomáha pri odlíšení komponentov od iných segmentov kódu, zjednodušuje identifikáciu a manipuláciu.
funkciuTlačidlo(rekvizity) {
vrátiť<tlačidlo>{props.label}tlačidlo>;
}V tomto príklade bola na pomenovanie komponentu použitá konvencia pomenovania PascalCase Tlačidlo.
7. Metódy pomenovania
Pri pomenovávaní metód je dôležité používať popisné názvy, ktoré úspešne oznamujú, čo metóda dosahuje, pretože metódy sú funkcie, ktoré sa týkajú objektu.
Napríklad:
triedaAuto{
konštruktér(značka, model) {
toto.make = robiť;
toto.modelka = modelka;
}
startEngine() {
// kód na spustenie motora
}
stopEngine() {
// kód na zastavenie motora
}
}
}
Opisné mená (štartEngine, stopEngine) sa používajú pre metódy v tomto príklade, čím sa zabezpečí, že ich zamýšľaný účel bude ľahko pochopiteľný.
8. Pomenovanie súkromných funkcií
Funkcie definované ako súkromné sú obmedzené na prístup len v rámci objektu, kde sú definované. Je dôležité pridať úvodný znak podčiarknutia (_), ktorý označuje, že funkcie sú súkromné.
Tu je príklad:
triedaAuto{
konštruktér(značka, model) {
toto.make = robiť;
toto.modelka = modelka;
}
_startEngine() {
// kód na spustenie motora
}
_stopEngine() {
// kód na zastavenie motora
}
}
Použitím úvodného podčiarknutia v tomto príklade znamená, že funkcie sú súkromné.
9. Pomenovanie globálnych premenných
K premenným, ktoré sú klasifikované ako globálne, je možné pristupovať z ktorejkoľvek časti kódovej základne. Pri pomenovávaní takýchto globálnych premenných je dôležité používať jasné a popisné názvy, ktoré efektívne vyjadrujú ich zamýšľaný účel.
Napríklad:
konšt MAX_PRICE = 1000;
konšt MIN_PRICE = 0;
funkciuskontrolujte cenu(cena) {
ak (cena > MAX_PRICE) {
// kód na zvládnutie vysokých cien
} inakak (cena < MIN_PRICE) {
// kód na zvládnutie nízkych cien
}
}
10. Pomenovanie súborov
Efektívna organizácia súborov je kľúčovým aspektom úspešného riadenia projektu JavaScript. Na zabezpečenie zjednodušených a konzistentných konvencií pomenovaní je nevyhnutné oddeliť slová v názvoch súborov pomocou malých písmen a pomlčiek.
Uprednostňujú sa malé písmená, pretože JavaScript je jazyk, v ktorom sa rozlišujú malé a veľké písmená, čo znamená, že jazyk zaobchádza s malými a veľkými písmenami odlišne. Použitie malých písmen v názvoch súborov zaisťuje konzistentnosť a zabraňuje zmätku pri odkazovaní na súbory v kóde.
Spojovníky sa používajú na oddelenie slov v názvoch súborov, pretože v názvoch súborov nie sú povolené medzery. Môžu sa použiť aj iné alternatívy, ako sú podčiarkovníky alebo camelCase, ale pre ich čitateľnosť sa vo všeobecnosti uprednostňujú pomlčky.
Pomocou pomlčiek sú názvy súborov prístupnejšie aj pre používateľov s čítačkami obrazovky alebo inými pomocnými technológiami.
moja aplikácia/
├── src/
├── komponenty/
├── button.js
├── input-field.js
├── utils/
├── string-utils.js
├── date-utils.js
├── app.js
├── index.jsV tomto príklade sa na oddelenie slov v názvoch súborov používajú malé písmená a spojovníky.
Dôležitosť dodržiavania konvencií názvov v JavaScripte
Dodržiavanie dobrých konvencií názvov je základným aspektom písania čistého a udržiavateľného kódu v JavaScripte. Dodržiavaním týchto konvencií môžete urobiť svoj kód čitateľnejším a udržovateľnejším, najmä v niektorých Frameworky JavaScript, kde sa od vás vyžaduje manipulácia s objemným kódom, čo vám môže ušetriť čas a námahu dlhý beh.
