A tiszta kód megírása az, amit tudnia kell és meg kell tennie, hogy profi fejlesztőnek tudja magát nevezni. Nincs ésszerű mentség arra, hogy bármi kevesebbet tegyen, mint a legjobb, amit tehet.

megtisztítani

Ebben a blogbejegyzésben schoolofJavaScript.com, Foglalkozunk a változók és függvények elnevezésének és használatának általános tiszta kódolási elveivel, valamint a JavaScript-specifikus tiszta kódolással.

Először is, mit jelent a tiszta kódolás?

A tiszta kódolás azt jelenti, hogy először kódot ír, hogy később maga és munkatársai, nem pedig a gép számára ellenőrizhesse.

Tudod, hogy tiszta kóddal dolgozol, amikor minden elolvasott rutin nagyjából olyanra fordul, mint amire számítottál.

A tiszta JavaScript-kód bevált módszerei

Most, hogy tudjuk, mire kell törekednie az egyes fejlesztőknek, fedezzük fel a legjobb gyakorlatokat!

Hogyan nevezzem meg a változókat?

Használjon olyan neveket, amelyek feltárják a szándékokat, és ne aggódjon, ha hosszú változónevekkel rendelkezik, ahelyett, hogy néhány billentyűleütést elmentene.

Ha betartja ezt a gyakorlatot, akkor a nevei kereshetők, ami sokat segít, ha refraktereket végeznek, vagy csak keresnek valamit.

Ezenkívül tegyen jelentős különbségeket, és ne adjon extra és felesleges neveket a változó nevekhez, például típusukhoz (magyar jelölés).


Tegye könnyedén változóneveik kiejtését, mert kevesebb erőfeszítésre van szükség ahhoz, hogy az emberi elme feldolgozza őket.

Amikor kódteszteket készít fejlesztő társaival, ezekre a nevekre könnyebb hivatkozni.

Röviden: ne okozzon további gondolattérképezést a nevével.

Hogyan kell megírnom a funkcióimat?

A funkcióinak egy dolgot csak absztrakció szinten kell végrehajtaniuk.


Miután helyesen megírta a funkcióit, tesztelheti, hogy mennyire járt jól a CPU-profil, ami segít megtalálni a szűk keresztmetszeteket.

Használjon hosszú, leíró neveket

A függvénynévnek igének vagy igemondának kell lennie, és közölnie kell szándékát, valamint az argumentumok sorrendjét és szándékát.

A hosszú, leíró név sokkal jobb, mint egy rövid, rejtélyes név vagy egy hosszú, leíró megjegyzés.

Kerülje az érvek hosszú listáját

Helyette egyetlen objektumparamétert és restrukturáló leképezést használ. Sokkal könnyebbé teszi az opcionális paraméterek kezelését is.

Csökkentse a mellékhatásokat.

Használjon tiszta funkciókat mellékhatások nélkül, amikor csak teheti. Nagyon könnyen használhatóak és tesztelhetők.

Rendezze a függvényeit egy fájlba a leminősítési szabály szerint
A legfelső szintű funkcióknak a felső és az alsó szinten kell lenniük. Természetté teszi a forráskód olvasását.

Konzultáció vagy módosítás

A függvényeknek valamit meg kell tenniük (módosítaniuk) vagy válaszolniuk kell valamire (lekérdezésre), de nem mindkettőre.

Mindenki másképp szereti a JavaScriptet írni, mit kell tennie?
Mivel a JavaScript dinamikus és rugalmasan írt, különösen hajlamos a programozási hibákra.

Használja a vállalati munkaszabályokat és a formázási stílust.

Minél szigorúbbak a szabályok, annál kevesebb erőfeszítést fognak tenni arra, hogy a kódellenőrzések során rossz formátumra mutassanak rá. Olyan dolgokra kell kiterjednie, mint az állandó nevek, a behúzás mérete, a szóköz elhelyezése és még a pontosvessző is.
Kezdetnek a szokásos JS stílus elég jó, de véleményem szerint nem elég szigorú. Az Airbnb stílusában elfogadhatom a legtöbb szabályt .

Hogyan írjunk szép aszinkron kódot?

Használd az ígéreteket, amikor csak tudod.

Az ígéretek natív módon érhetők el a 4. csomópontból. A beágyazott visszahívások írása helyett életképes ígérethívásokat is kezdeményezhet.

A legtöbb könyvtár rendelkezik visszahívó és ígéretes felülettel, az utóbbiakat részesíti előnyben. A visszahívási API-kat ígéret alapúvá is konvertálhatja, ha olyan csomagokkal csomagolja őket, mint az es6-Promify .

Hogyan írjak performant kódot?

Először tiszta kódot kell írnia, majd a profil segítségével meg kell találnia a teljesítmény szűk keresztmetszeteit.

Soha ne próbálja meg először megírni a teljesítményt és az intelligens kódot, ehelyett optimalizálja a kódot, amikor szüksége van rá, és a tényleges hatásra hivatkozjon a mikromértékek helyett.

Van azonban néhány egyszerű forgatókönyv, például a lehetőségek lelkes inicializálása (pl. Joi sémák az útvonalkezelőkben, amelyeket minden kérésre használnának, és ha minden alkalommal újra létrehoznák a rezsit), és a zárkód helyett aszinkron kódot használnak.