10 alapvető JavaScript elnevezési konvenció, amelyet minden fejlesztőnek ismernie kell

Az összetett JavaScript-projektek kezeléséhez elengedhetetlen az egyszerűség, az olvashatóság és a könnyű karbantartás fenntartása a kódban. E cél elérésének kulcsa az elnevezési konvenciók következetes betartása.

A változók, logikai értékek, függvények, konstansok, osztályok, komponensek, metódusok, privát függvények, globális változók és fájlok a következetes elnevezési konvenciót igénylő JavaScript-elemek közé tartoznak. Javíthatja a kódok rendszerezését és megértését azáltal, hogy szabványos elnevezési konvenciókat alkalmaz ezen összetevők mindegyikében, így időt és erőfeszítést takaríthat meg hosszú távon.

1. Változók elnevezése

A JavaScriptben az adatok változókban tárolódnak. Elengedhetetlen, hogy olyan leíró neveket válasszunk a változóknak, amelyek pontosan tükrözik a funkciójukat. Például helyettesítheti felhasználónév vagy teljes ár változó nevére, nem pedig x.

A változók elnevezésének jó módja a következő:

hagyja összár = 100;
hagyja felhasználónév = "János";

A kód olvashatóságának javítása leíró változónevek használatával érhető el

2. Boolean elnevezés

Változók, amelyeknek csak két értéke lehet, azaz bármelyik igaz vagy hamis, Boolean néven ismertek. Nagyon fontos, hogy megfelelő neveket válasszunk a logikai változóknak, amelyek kifejezik a céljukat.

Szemléltetésképpen ahelyett, hogy egy változónév mellett döntenénk, mint pl igaz, akkor inkább menj vele érvényes vagy hasValue.

Tekintsük ezt a példát:

hagyja isValid = igaz;
hagyja hasValue = hamis;

Ebben a példában a leíró logikai változónevek egyértelművé teszik, hogy mit képviselnek.

3. Funkciók elnevezése

A JavaScript funkciója egy önálló kódegységre utal, amely egy adott feladat végrehajtására szolgál. Ez egy kódblokk, amelyet a kód más részei hívhatnak vagy hívhatnak meg, és független entitásként működik.

A funkciók hatékony elnevezéséhez használjon leíró neveket, amelyek kifejezik a céljukat. Például ahelyett függvény létrehozásafoo, válasszon szemléletesebb neveket, mint pl valideUserInput vagy Számítsa ki a TotalPrice-t.

Például:

funkcióSzámítsa ki a TotalPrice-t(ár, mennyiség) {
Visszatérés ár * mennyiség;
}
funkcióvalideUserInput(bemenet) {
Visszatérés bemenet !== határozatlan && bemenet !== nulla;
}

4. Konstansok elnevezése

A konstansok olyan változók, amelyek nem rendelhetők hozzá újra. Az állandók elnevezésekor fontos, hogy minden nagybetűt és aláhúzást használjunk a szavak elválasztásához.

Például:

const MAX_PRICE = 1000;
const MIN_PRICE = 0;

Ebben a példában minden nagybetűt és aláhúzást használtunk a szavak elválasztására a konstans nevekben.

5. Osztályok elnevezése

A JavaScriptben az objektumok osztályoknak nevezett tervrajzok segítségével hozhatók létre. A kifogástalan elnevezési gyakorlat elérése érdekében rendkívül fontos a PascalCase végrehajtása, egy elnevezési konvenció, amely minden szó első betűjét nagybetűvel írja elő.

Vegyük például:

osztályBevásárlókocsi{
konstruktőr(márka, modell) {
ez.make = gyárt;
ez.model = modell;
 }
}

Ebben a példában az osztály Bevásárlókocsi PascalCase használatával lett elnevezve, ami azt jelenti, hogy az osztálynévben minden szó első betűje nagybetűvel íródott, és nincsenek szóközök vagy aláhúzásjelek a szavak között.

6. Összetevők elnevezése

Az összetevők a modern szoftverfejlesztés alapvető építőkövei, különösen a szoftverfejlesztésben keretrendszerek, mint a React, amelyek az újrafelhasználható kódot hangsúlyozzák.

Egy összetett felhasználói felület vagy alkalmazás kisebb, kezelhető darabokra bontásával létrehozhat komponensek, amelyek újra felhasználhatók különböző projektekben, csökkentve a fejlesztési időt és növelve a kódszámot hatékonyság.

Ismét erősen javasoljuk a PascalCase elnevezési konvenció használatát az összetevők elnevezéséhez. Ez azt jelenti, hogy az összetevő nevében minden szó első betűjét nagybetűvel írjuk.

Ez a konvenció segít az összetevők megkülönböztetésében más kódszegmensektől, egyszerűsítve az azonosítást és a manipulációt.

funkcióGomb(kellékek) {
Visszatérés<gomb>{props.label}gomb>;
}

Ebben a példában a PascalCase elnevezési megállapodást használtuk az összetevő elnevezésére Gomb.

7. Elnevezési módszerek

A metódusok elnevezésekor kulcsfontosságú, hogy leíró neveket használjunk, amelyek sikeresen kommunikálják a metódus teljesítményét, mivel a metódusok olyan függvények, amelyek egy objektumra vonatkoznak.

Például:

osztályAutó{
konstruktőr(márka, modell) {
ez.make = gyárt;
ez.model = modell;
 }
 startEngine() {
// kód a motor indításához 
 } 
 stopEngine() { 
// kód a motor leállításához 
 }
 }
}

Leíró nevek (indítsa el a motort, állítsa le a motort).

8. Privát függvények elnevezése

A privátként meghatározott funkciók csak azon az objektumon belül érhetők el, ahol meghatározásra kerültek. Nagyon fontos, hogy egy bevezető aláhúzást (_) jelöljön meg, hogy a funkciók privátak.

Íme egy példa:

osztályAutó{
konstruktőr(márka, modell) {
ez.make = gyárt;
ez.model = modell;
 }
 _startEngine() {
// kód a motor indításához
 }
 _stopEngine() {
// kód a motor leállításához
 }
}

Ebben a példában a bevezető aláhúzás használata azt jelzi, hogy a függvények privátak.

9. Globális változók elnevezése

A globálisnak minősített változók a kódbázis bármely részéből elérhetők. Az ilyen globális változók elnevezése során kulcsfontosságú, hogy világos és leíró neveket használjunk, amelyek hatékonyan tükrözik a tervezett célt.

Például:

const MAX_PRICE = 1000;
const MIN_PRICE = 0;
funkciócheckPrice(ár) {
ha (ár > MAX_PRICE) {
// kód a magas árak kezelésére
 } másha (ár < MIN_PRICE) {
// kód az alacsony árak kezelésére
 }
}

10. Fájlok elnevezése

A hatékony fájlszervezés a sikeres JavaScript-projektkezelés kulcsfontosságú eleme. Az egyszerűsített és következetes elnevezési konvenciók biztosítása érdekében elengedhetetlen, hogy a fájlnevekben a szavakat kisbetűkkel és kötőjelekkel különítse el.

A kisbetűket részesítjük előnyben, mivel a JavaScript nyelv érzékeny a kis- és nagybetűkre, ami azt jelenti, hogy a nyelv eltérően kezeli a kis- és nagybetűket. A kisbetűk használata a fájlnevekben biztosítja a konzisztenciát, és elkerüli a félreértést, amikor fájlokra hivatkozik a kódban.

A kötőjelek a szavak elválasztására szolgálnak a fájlnevekben, mivel a szóköz nem megengedett a fájlnevekben. Más alternatívák, például aláhúzásjelek vagy camelCase is használhatók, de általában a kötőjeleket részesítik előnyben az olvashatóság miatt.

A kötőjelek használata a fájlneveket is elérhetőbbé teszi a képernyőolvasóval vagy más segítő technológiával rendelkező felhasználók számára.

én-app/
├── src/
 ├── alkatrészek/
 ├── button.js
 ├── input-field.js
├── utils/
 ├── string-utils.js
 ├── date-utils.js
├── app.js
├── index.js

Ebben a példában kisbetűket és kötőjeleket használunk a szavak elválasztására a fájlnevekben.

A névadási konvenciók követésének fontossága a JavaScriptben

A jó elnevezési konvenciók betartása elengedhetetlen szempont a tiszta és karbantartható kód JavaScriptben történő írásához. Ezen konvenciók betartásával a kódot olvashatóbbá és karbantarthatóbbá teheti, különösen egyes esetekben JavaScript-keretrendszerek, ahol terjedelmes kódot kell kezelnie, ami időt és erőfeszítést takaríthat meg a Hosszú távon.