Uzlabojiet sava JavaScript koda lasāmību un apkopi, ievērojot šos nosaukumu piešķiršanas noteikumus.
Lai pārvaldītu sarežģītus JavaScript projektus, ir svarīgi saglabāt kodu vienkāršību, lasāmību un vieglu apkopi. Konsekventa nosaukumu piešķiršanas konvenciju ievērošana ir šī mērķa sasniegšanas atslēga.
Mainīgie, Būla vērtības, funkcijas, konstantes, klases, komponenti, metodes, privātās funkcijas, globālie mainīgie un faili ir vieni no JavaScript elementiem, kuriem nepieciešama konsekventa nosaukumu piešķiršanas metode. Varat uzlabot koda organizēšanu un izpratni, ieviešot standartizētas nosaukumu piešķiršanas konvencijas visos šajos komponentos, ietaupot laiku un pūles ilgtermiņā.
1. Mainīgo nosaukumu piešķiršana
Programmā JavaScript dati tiek glabāti mainīgajos. Ir svarīgi izvēlēties mainīgo lielumu aprakstošus nosaukumus, kas precīzi atspoguļo to funkciju. Jūs varētu, piemēram, aizstāt lietotājvārds vai Kopējā cena mainīgā nosaukumam, nevis x.
Labs veids, kā nosaukt mainīgos, ir šāds:
ļaut kopējā cena = 100;
ļaut lietotājvārds = "Džons";
Uzlabotu koda lasāmību var panākt, izmantojot aprakstošus mainīgo nosaukumus
2. Būla nosaukšana
Mainīgie, kuriem var būt tikai divas vērtības, t.i., vai nu taisnība vai viltus, ir pazīstami kā Būla. Ir ļoti svarīgi izvēlēties atbilstošus nosaukumus Būla mainīgajiem, kas izsaka to mērķi.
Lai ilustrētu, tā vietā, lai izvēlētos mainīgo nosaukumu, piemēram, ir patiess, jums vajadzētu dot priekšroku ir derīgs vai hasValue.
Apsveriet šo gadījumu:
ļaut isValid = taisnība;
ļaut hasValue = viltus;
Šajā piemērā aprakstošie Būla mainīgo nosaukumi skaidri parāda, ko tie pārstāv.
3. Nosaukšanas funkcijas
JavaScript funkcija attiecas uz autonomu koda vienību, kas paredzēta noteikta uzdevuma veikšanai. Tas ir koda bloks, ko var izsaukt vai izsaukt citas koda daļas, un tas darbojas kā neatkarīga vienība.
Lai efektīvi nosauktu funkcijas, izmantojiet aprakstošus nosaukumus, kas atspoguļo to mērķi. Piemēram, tā vietā funkcijas izveidošanafoo, izvēlieties ilustratīvākus nosaukumus, piemēram, valideUserInput vai aprēķināt TotalPrice.
Piemēram:
funkcijuaprēķināt TotalPrice(cena, daudzums) {
atgriezties cena * daudzums;
}
funkcijuvalideUserInput(ievade) {
atgriezties ievade !== nenoteikts && ievade !== null;
}
4. Konstantu nosaukšana
Konstantes ir mainīgie, kurus nevar piešķirt no jauna. Nosaucot konstantes, vārdu atdalīšanai ir svarīgi izmantot visus lielos burtus un pasvītrojumus.
Piemēram:
konst MAX_PRICE = 1000;
konst MIN_PRICE = 0;
Šajā piemērā visi lielie burti un pasvītras ir izmantoti, lai atdalītu vārdus nemainīgajos nosaukumos.
5. Nosaukšanas klases
Programmā JavaScript objektus var izveidot, izmantojot rasējumus, ko sauc par klasēm. Lai panāktu nevainojamu nosaukumu piešķiršanas praksi, ir ārkārtīgi svarīgi izpildīt PascalCase — nosaukumu piešķiršanas principu, kas nosaka katra vārda pirmo burtu lielos burtus.
Ņemiet, piemēram:
klasēIepirkšanās ratiņi{
konstruktors(marka, modelis) {
šis.make = make;
šis.model = modelis;
}
}
Šajā piemērā klase Iepirkšanās ratiņi ir nosaukts, izmantojot PascalCase, kas nozīmē, ka katra vārda pirmais burts klases nosaukumā ir rakstīts ar lielo burtu un starp vārdiem nav atstarpes vai pasvītras.
6. Komponentu nosaukšana
Komponenti ir būtiski mūsdienu programmatūras izstrādes elementi, jo īpaši ietvariem, piemēram, React, kas uzsver atkārtoti lietojamu kodu.
Sadalot sarežģītu lietotāja interfeisu vai lietojumprogrammu mazākās, pārvaldāmās daļās, varat izveidot komponenti, kurus var atkārtoti izmantot dažādos projektos, samazinot izstrādes laiku un palielinot kodu efektivitāti.
Atkal mēs ļoti iesakām komponentu nosaukšanai izmantot PascalCase nosaukšanas konvenciju. Tas nozīmē, ka komponenta nosaukumā katra vārda pirmo burtu lieto ar lielo burtu.
Šāda vienošanās palīdz jums atšķirt komponentus no citiem koda segmentiem, vienkāršojot identifikāciju un manipulācijas.
funkcijuPoga(rekvizīti) {
atgriezties<pogu>{props.label}pogu>;
}
Šajā piemērā komponenta nosaukšanai ir izmantota PascalCase nosaukšanas vienošanās Poga.
7. Nosaukšanas metodes
Nosaucot metodes, ir ļoti svarīgi izmantot aprakstošus nosaukumus, kas veiksmīgi informē par metodes paveikto, jo metodes ir funkcijas, kas attiecas uz objektu.
Piemēram:
klasēAutomašīna{
konstruktors(marka, modelis) {
šis.make = make;
šis.model = modelis;
}
startEngine() {
// kods dzinēja iedarbināšanai
}
stopEngine() {
// kods dzinēja apturēšanai
}
}
}
Aprakstošie nosaukumi (iedarbinātDzinējs, stopDzinējs) tiek izmantoti šajā piemērā minētajām metodēm, nodrošinot, ka to paredzētais mērķis ir viegli saprotams.
8. Privāto funkciju nosaukšana
Funkcijas, kas definētas kā privātas, var piekļūt tikai objektā, kurā tās ir definētas. Ir ļoti svarīgi pievienot pasvītrojumu (_), lai norādītu, ka funkcijas ir privātas.
Šeit ir piemērs:
klasēAutomašīna{
konstruktors(marka, modelis) {
šis.make = make;
šis.model = modelis;
}
_startEngine() {
// kods dzinēja iedarbināšanai
}
_stopEngine() {
// kods dzinēja apturēšanai
}
}
Šajā piemērā izmantojot pasvītrojumu, tiek norādīts, ka funkcijas ir privātas.
9. Globālo mainīgo nosaukumu piešķiršana
Mainīgajiem, kas ir klasificēti kā globāli, var piekļūt no jebkuras koda bāzes daļas. Nosaucot šādus globālos mainīgos, ir ļoti svarīgi izmantot skaidrus un aprakstošus nosaukumus, kas efektīvi atspoguļo to paredzēto mērķi.
Piemēram:
konst MAX_PRICE = 1000;
konst MIN_PRICE = 0;
funkcijupārbaudīt Cena(cena) {
ja (cena > MAX_PRICE) {
// kods, lai apstrādātu augstas cenas
} citsja (cena < MIN_PRICE) {
// kods, lai apstrādātu zemas cenas
}
}
10. Failu nosaukumu piešķiršana
Efektīva failu organizēšana ir būtisks veiksmīgas JavaScript projektu pārvaldības aspekts. Lai nodrošinātu racionalizētas un konsekventas nosaukumu piešķiršanas metodes, ir svarīgi vārdus failu nosaukumos atdalīt, izmantojot mazos burtus un defises.
Priekšroka tiek dota mazajiem burtiem, jo JavaScript valoda ir reģistrjutīga, kas nozīmē, ka valoda mazie un lielie burti tiek apstrādāti atšķirīgi. Mazo burtu izmantošana failu nosaukumos nodrošina konsekvenci un novērš neskaidrības, atsaucoties uz failiem kodā.
Defises tiek izmantotas, lai atdalītu vārdus failu nosaukumos, jo failu nosaukumos nav atļautas atstarpes. Var izmantot arī citas alternatīvas, piemēram, pasvītras vai camelCase, taču parasti priekšroka tiek dota defisēm to lasāmības dēļ.
Izmantojot defises, failu nosaukumi ir vieglāk pieejami lietotājiem, kuri izmanto ekrāna lasītājus vai citas palīgtehnoloģijas.
mana lietotne/
├── src/
├── sastāvdaļas/
├── button.js
├── ievades lauks.js
├── utils/
├── string-utils.js
├── date-utils.js
├── app.js
├── index.js
Šajā piemērā vārdu nosaukšanai failu nosaukumos tiek izmantoti mazie burti un defises.
Nosaukumu piešķiršanas konvenciju ievērošanas nozīme JavaScript
Labu nosaukumu piešķiršanas noteikumu ievērošana ir būtisks aspekts tīra un uzturējama koda rakstīšanai JavaScript. Ievērojot šos noteikumus, varat padarīt savu kodu lasāmāku un apkopjamāku, īpaši dažos JavaScript ietvari, kuros jums ir jāapstrādā apjomīgs kods, kas var ietaupīt laiku un pūles ilgtermiņā.