A „Clean Code” 6. könyv szabályai az optimális elnevezéshez
Fabien, Webfejlesztő 2019. augusztus 28
A Clean Code (vagy a Clean Code eredeti változatában) fejlesztőkönyvet Robert C. Martin írta. 1970 óta professzionális fejlesztő, 1990-ben nemzetközi szoftver tanácsadó is lett. A könyv megírásához a szerző egy tapasztalt fejlesztőkből álló csapattal vette körül magát, hogy megossza a kóddal kapcsolatos legjobb gyakorlatokat.
A Clean Code könyv célja tehát a jó kód alapjainak elsajátítása és az általa nyújtott előnyök megértése. Ez adja a kulcsokat a rossz kód jó kóddá alakításához.
Ez a cikk Robert C. Martin könyvének első áttekintése. Főként a „The Naming” első részhez térünk vissza. A szerző meghatározza, hogy mit tart jó kódnak. Ez a rész az objektumok és változók elnevezésének nehézségével is foglalkozik a számítógépes fejlesztésben.
Fontos az idő, hogy jól kódoljunk
Amikor a "később" azt jelenti, hogy "soha"
A Coder Proprementben a szerző visszatér a'' a jó kód egyik legfőbb akadálya: az idő elfogyásának érzése. A hanyag kód azonban nagyjából hosszú távon elkerülhetetlen időpazarlás forrása.
Gyakran előfordul, hogy amikor kifutunk az időből, azt gondoljuk, hogy később visszatérünk, hogy kitakarítsuk vagy kiszámítsuk a hibás kódot. De tényleg úgy gondolja, hogy később talál még több időt ?
Dave LeBlanc véleményét fejezi ki Leblanc-törvényében:Később soha nem jelenti azt”(Az angol későbbi egyenlőségből soha). A halogatás gyakran azzal jár, hogy soha nem fejezi be megfelelően a munkáját, túlságosan elfoglalt az új küldetésekkel. Ezért fontos az optimális szervezés, annak érdekében, hogy a megfelelő időben a kódjára fordítsuk a megérdemelt időt.
Hagyja a kódot tisztábbnak, mint amennyit megtalált
Egy másik idézet kiigazítja a fiú robogó szabályát, hogy jó kódexszabálysá változtassa: „Hagyja tisztábbnak a kempinget, mint amennyit megérkezéskor talált.” BECOMES "Hagyja a kódot tisztábbnak, mint amennyit megtalált.”
Valójában, ha mindegyik egy kicsit tisztábbá teszi a kódot, mint a helyreállított kód, akkor a kódot nem lehet lebontani. Az egyszerű tisztítás néha nagyon hasznos lehet. Változó átnevezése, függvény felosztása vagy enyhe redundancia eltávolítása például javíthatja a kód minőségét.
A kódelemek helyes elnevezése
A könyv első része a fejlesztők által jól ismert visszatérő problémára vonatkozik: változók, osztályok, függvények megnevezése stb. Azonban minden fejlesztőnek megvan a saját meghatározása a jó kódról. Néha nehéz megtalálni az abszolút igazságot arról, hogy mi a Jó kódex.
A szerző itt tapasztalataira támaszkodik, hogy átadja saját bevált gyakorlatait, különös tekintettel a névadásra.
Az alábbiakban felsoroljuk a könyvben javasolt 6 szabályt az optimális elnevezés érdekében.
1. Feltárja szándékait a névben
Robert C. Martin szerint a névadás során az első ökölszabály, hogy olyan nevet használjon, amely feltárja a szándékokat. Ennek a névnek tájékoztatnia kell céljáról, küldetéséről és használatáról.