Parandage oma JavaScripti koodi loetavust ja hooldatavust, järgides neid nimetavasid.
Keeruliste JavaScripti projektide haldamiseks on oluline säilitada koodi lihtsus, loetavus ja hõlpsasti hooldatavus. Selle eesmärgi saavutamise võti on nimede määramise tavade järjekindel järgimine.
Muutujad, tõeväärtus, funktsioonid, konstandid, klassid, komponendid, meetodid, privaatfunktsioonid, globaalsed muutujad ja failid kuuluvad JavaScripti elementide hulka, mis nõuavad järjepidevat nimetamiskokkulepet. Saate parandada koodi korraldust ja arusaamist, rakendades kõigis nendes komponentides standardiseeritud nimetamiskokkuleppeid, säästes pikas perspektiivis aega ja vaeva.
1. Muutujate nimetamine
JavaScriptis salvestatakse andmed muutujatena. Oluline on valida muutujatele kirjeldavad nimed, mis kajastavad täpselt nende funktsiooni. Võite näiteks asendada kasutajanimi või koguhind pigem muutuja nime kui x.
Hea viis muutujate nimetamiseks on järgmine:
lase koguhind = 100;
lase kasutajanimi = "John";Täiustatud koodi loetavust saab saavutada kirjeldavate muutujate nimede kasutamisega
2. Booleani nimetamine
Muutujad, millel võib olla ainult kaks väärtust, st kumbki tõsi või vale, on tuntud kui Boolean. Oluline on valida tõeväärtuslike muutujate jaoks sobivad nimed, mis väljendavad nende eesmärki.
Illustreerimiseks, selle asemel, et valida muutuja nimi, näiteks on tõsi, peaksite eelistama kaasas käimist on kehtiv või hasValue.
Mõelge sellele juhtumile:
lase isValid = tõsi;
lase hasValue = vale;Selles näites teevad kirjeldavad tõeväärtuse muutujate nimed selgeks, mida nad esindavad.
3. Funktsioonide nimetamine
Funktsioon JavaScriptis viitab iseseisvale koodiühikule, mis on ette nähtud konkreetse ülesande täitmiseks. See on koodiplokk, mida koodi teised osad saavad kutsuda või välja kutsuda ja mis toimib iseseisva üksusena.
Funktsioonide tõhusaks nimetamiseks kasutage kirjeldavaid nimesid, mis annavad edasi nende eesmärki. Näiteks selle asemel funktsiooni loominefoo, valige illustreerivamad nimed nagu valideUserInput või arvutaKoguhind.
Näiteks:
funktsiooniarvutaKoguhind(hind, kogus) {
tagasi hind * kogus;
}
funktsioonivalideUserInput(sisend) {
tagasi sisend !== määratlemata && sisend !== null;
}
4. Konstantide nimetamine
Konstandid on muutujad, mida ei saa ümber määrata. Konstantide nimetamisel on oluline kasutada sõnade eraldamiseks kõiki suurtähti ja allkriipse.
Näiteks:
konst MAX_PRICE = 1000;
konst MIN_PRICE = 0;Selles näites on konstantsete nimede sõnade eraldamiseks kasutatud kõiki suuri tähti ja allkriipse.
5. Klasside nimetamine
JavaScriptis saab objekte luua klassideks kutsutavate jooniste abil. Laitmatu nimeandmispraktika saavutamiseks on ülimalt oluline käivitada PascalCase, mis on nimetamiskonventsioon, mis kohustab kasutama iga sõna algustähti.
Võtke näiteks:
klassOstukorv{
konstruktor(mark, mudel) {
see.make = valmistama;
see.mudel = mudel;
}
}
Selles näites klass Ostukorv on nimetatud PascalCase'i abil, mis tähendab, et klassi nimes on iga sõna esimene täht kirjutatud suurtähtedega ning sõnade vahel ei ole tühikuid ega allkriipse.
6. Komponentide nimetamine
Komponendid on kaasaegse tarkvaraarenduse olulised ehitusplokid, eriti tarkvaraarenduses raamistikud nagu React, mis rõhutavad korduvkasutatavat koodi.
Keerulise kasutajaliidese või rakenduse väiksemateks hallatavateks osadeks jagades saate luua komponente, mida saab erinevates projektides uuesti kasutada, vähendades arendusaega ja suurendades koodi tõhusust.
Jällegi soovitame komponentide nimetamiseks kasutada PascalCase'i nimetamise tava. See tähendab komponendi nimes iga sõna esitähe kirjutamist suurtähtedega.
Selline konventsioon aitab teil eristada komponente teistest koodisegmentidest, lihtsustades tuvastamist ja manipuleerimist.
funktsiooniNupp(rekvisiidid) {
tagasi<nuppu>{props.label}nuppu>;
}Selles näites on komponendi nimetamiseks kasutatud PascalCase'i nimetamise tava Nupp.
7. Nimede andmise meetodid
Meetodite nimetamisel on ülioluline kasutada kirjeldavaid nimesid, mis edastavad edukalt meetodi saavutusi, kuna meetodid on funktsioonid, mis on seotud objektiga.
Näiteks:
klassAuto{
konstruktor(mark, mudel) {
see.make = valmistama;
see.mudel = mudel;
}
startEngine() {
// kood mootori käivitamiseks
}
stopEngine() {
// kood mootori seiskamiseks
}
}
}
Kirjeldavad nimed (käivitage mootor, peatada mootor) kasutatakse selle näite meetodite jaoks, tagades, et nende eesmärk on hõlpsasti mõistetav.
8. Privaatsete funktsioonide nimetamine
Privaatsete funktsioonide juurdepääs on piiratud ainult objekti sees, kus need on määratletud. Ülioluline on lisada allkriips (_), mis näitab, et funktsioonid on privaatsed.
Siin on näide:
klassAuto{
konstruktor(mark, mudel) {
see.make = valmistama;
see.mudel = mudel;
}
_startEngine() {
// kood mootori käivitamiseks
}
_stopEngine() {
// kood mootori seiskamiseks
}
}
Kui kasutate selles näites eesjoont, osutatakse, et funktsioonid on privaatsed.
9. Globaalsete muutujate nimetamine
Globaalseteks klassifitseeritud muutujatele pääseb juurde koodibaasi mis tahes osast. Selliste globaalsete muutujate nimetamisel on ülioluline kasutada selgeid ja kirjeldavaid nimesid, mis annavad tõhusalt edasi nende kavandatud eesmärki.
Näiteks:
konst MAX_PRICE = 1000;
konst MIN_PRICE = 0;
funktsioonikontrolli hinda(hind) {
kui (hind > MAX_PRICE) {
// kood kõrgete hindade käsitlemiseks
} muidukui (hind < MIN_PRICE) {
// kood madalate hindade käsitlemiseks
}
}
10. Failide nimetamine
Tõhus failikorraldus on eduka JavaScripti projektihalduse oluline aspekt. Lihtsustatud ja järjepidevate nimetamistavade tagamiseks on oluline eraldada failinimedes sõnad väiketähtede ja sidekriipsudega.
Eelistatakse väiketähti, kuna JavaScript on tõstutundlik keel, mis tähendab, et keel käsitleb väike- ja suurtähti erinevalt. Väiketähtede kasutamine failinimedes tagab järjepidevuse ja väldib segadust koodis failidele viitamisel.
Sidekriipse kasutatakse sõnade eraldamiseks failinimedes, kuna failinimedes pole tühikud lubatud. Võib kasutada ka muid alternatiive, näiteks allkriipse või camelCase'i, kuid nende loetavuse tõttu eelistatakse üldiselt sidekriipse.
Sidekriipsude kasutamine muudab failinimed ka ekraanilugejate või muude abitehnoloogiatega kasutajatele juurdepääsetavamaks.
minu rakendus/
├── src/
├── komponendid/
├── button.js
├── input-field.js
├── utils/
├── string-utils.js
├── date-utils.js
├── app.js
├── index.jsSelles näites kasutatakse failinimedes sõnade eraldamiseks väiketähti ja sidekriipse.
Nimetamiskonventsioonide järgimise tähtsus JavaScriptis
Heade nimetamistavade järgimine on JavaScriptis puhta ja hooldatava koodi kirjutamise oluline aspekt. Neid tavasid järgides saate muuta oma koodi loetavamaks ja hooldatavamaks, eriti mõnes JavaScripti raamistikud, kus peate käsitlema mahukat koodi, mis võib säästa teie aega ja vaeva pikk jooks.