A szoftverek világában gyakran lehet találkozni olyan helyzetekkel, amikor egy-egy folyamat valamilyen hiányosság miatt lezajlik, ráadásul tökéletesen. Ezen a ponton, bár nem profi módon bonyolították le a tranzakciót, a háttér nem sokat számít, hiszen az eredmény pozitív. A tiszta kód fogalma ezen értékelés alapján alakult ki. Ebben a tartalomban elmondjuk a kódolás alapelveit. tiszta kód Beszélni fogunk a koncepcióról és annak alapvető dinamikájáról.

Mi az a tiszta kód?

mi az a tiszta kód

Ha a megírandó kód hibamentes, könnyen érthető, szerkeszthető, összecsukható vagy bővíthető, akkor ezt a kódot tiszta kódnak nevezzük. Mi az a tiszta kód? A kérdésre ezzel a legrövidebb módon lehet válaszolni. A teljes értékelésről persze nem lehet néhány mondatban beszélni. A koncepcióval kapcsolatos fontos információk általánosságban a következők.

  • Egyszerűen átgondolhatónak és egyszerűen megvalósíthatónak kell lennie. Az összetévesztés elkerülése a koncepció legfontosabb jellemzője.
  • A kódot könnyen szerkeszthető módon kell megírni, figyelembe véve önmagát vagy azokat, akik utánad szerkesztik a kódot.
  • A koncepciót Robert Cecil Martin írta „Tiszta kód” A könyvhöz kapcsolódott, és onnan alakult ki.

A koncepció dinamikája nagyon egyszerű, és nagy jelentősége van a szoftvervilágban. Ez egy olyan koncepció, amelyet a könnyen érthető kódírás hibáinak kiküszöbölésére és a könnyebben szerkeszthető kódok írására vezettek be. Emiatt rendkívül fontos és elengedhetetlen a rendszeres tanulás.

Hogyan írjunk tiszta kódot?

hogyan kell-írni-tiszta-kódot

A kódnak könnyen érthetőnek kell lennie. Ez az alapvető dinamika. Ahhoz azonban, hogy egy kód bekerüljön a koncepcióba, a kódnak könnyen érthetőnek kell lennie nemcsak annak, aki a kódot írta, hanem egy másik személy számára is, aki később elolvassa és szerkeszti a kódot. Abban az esetben, ha nem így van "Rossz kód" fogalommal találkozunk. Figyelemre méltó, hogy a kód nem könnyen érthető, mivel a rossz kód nem tulajdonítható emberi minősítésnek. További fontos tényezők a következők.

  • Egyszerűnek kell lenned, egyszerűen írni és egyszerűen olvasni.
  • Hagyj egy egyszerűbb környezetet azoknak, akik utánad foglalkoznak a kóddal.
  • Meg kell tisztítani a hibáktól és hiányosságoktól. Az a tény, hogy hiba nélkül működik, nem változtat azon a tényen, hogy ez rossz kód.
  • Ne csökkentse az olvashatóságot összetett kódokkal. Próbáljon ki egyszerűbb kódstílusokat.
  • Rugalmasnak kell lennie sok különböző szerkezettel a polimorfizmus használatával.
  • Legyen óvatos a Dependency Injection használatával. Így a kód mentes minden függőségtől, és függetlenül szerkeszthető.
  • Az Ön által használt változó-, függvény-/módszer- és osztályneveknek egyértelműnek és leíró jellegűnek kell lenniük. Erre érdemes odafigyelni.
  • Az elnevezést helyesen kell megadni. Nagyon fontos, hogy később könnyen tudjunk keresni.
  • A használt funkciók nem hajthatnak végre egynél több műveletet. Csak olyan függvényeket kódoljon, amelyek elvégzik a saját feladatukat.
  • Kerülje a mellékhatásokat tartalmazó funkciókat.
  • Ne használjon felesleges megjegyzéssorokat, és a megjegyzéssoroknak leíró jellegűnek kell lenniük.
  • A funkciók áramlási irányának lefelé kell lennie, és nem szabad megzavarnia a bemélyedéseket.
  • Ügyeljen a nem statikus módszerek használatára.

Mint fentebb látható, a fenti dinamikát figyelembe kell venni a tiszta kód létrehozásához. Természetesen mindezen dinamikák megvalósítása a kódot író és olvasó személytől függ. Emiatt mindig próbáljon egyszerűnek lenni és egyszerűen olvasni.

Mi az a rossz kód?

hogyan kell-írni-tiszta-kódot

Amikor a kódot író személyről és a kód írásának időpontjáról van szó; Figyelembe véve az olyan problémákat, mint az idő, a rossz rendszer, az adminisztrációs hibák, rossz kódok merülhetnek fel. Ebben az összefüggésben olyan kódok, amelyek nem felelnek meg a tiszta kód kritériumainak, és nem helyesek és nem működőképesek, rossz kód hívják. Szóval, hogyan lehet felismerni a rossz kódot?

  • Ha nehéz olvasni és megérteni,
  • Ha a változtatások végrehajtása szinte lehetetlenné vált,
  • Ha sok a felesleges kód, és a kódok nehezen olvashatók, akkor azt mondhatjuk, hogy rossz kóddal állsz szemben.

Szóval tényleg létezik olyan, hogy rossz kód? Nem nehéz olyan irodalmat találni, amelyben ezt a fogalmat használják. Vannak azonban olyan szakirodalom is, amelyek szerint nem szabad ilyen fogalmat használni. Ennek az az oka, hogy a rossz kódnak mindenki számára más-más konnotációja lehet. Emiatt nem javasolt a rossz kód fogalmának használata.

Robert Cecil Martin klasszikusa „Tiszta kód” Ezzel a fogalommal találkozhatunk könyvében. A könyvben olyan szöveg található, hogy még a rossz kód is működhet. Tehát a rossz kód fogalmát említik. Nem lehet azonban túl nehéz kijelenteni, hogy ebben a kérdésben már vannak nézeteltérések. Tekintettel arra, hogy gyakran találkozunk a "Ez a kód rossz. Át kellene alakítanunk." fogalmával, egyértelmű, hogy létezik ilyen fogalom, és ennek szerepelnie kell a szakirodalomban. Szóval, szaga van a kódnak? Vizsgáljuk meg ezt.

Mi az a Code Smells?

kód-szagú-mi-rossz-szag-kód

A törökben jobb kifejezést lehet adni metaforával, vagyis nem szó szerinti jelentéssel. Olyannyira, hogy ez a helyzet nagyot javított törökségünkön és megerősítette a kifejezésmódot. itt kód szaga, így a rossz szagú kód is egy példa erre. Metafora, de nagyszerű magyarázat. Nos, Mi az a kódszag?

Ha az írott kódnak vannak olyan részei, amelyeket nem értenek, ha szükségtelen kódokat csináltak és ismételtek meg, ha a magyarázni szándékozottat kiterjesztik, és olvasás közben semmit sem értenek, rossz szag száll az orrába. Igen, ez a kód most büdös kód, vagyis kódszagú. Természetesen itt más a dinamika. Ezekre külön kell figyelni.

Hogyan lehet azonosítani a kódszagokat?

hogyan-érthető-rossz-szagú-kód-kód-szagok

Még ha a funkcióját maradéktalanul ellátja is, azok a kódok, amelyek ezt hosszú és érthetetlen módon végzik, a rossz szagú kódosztályba tartoznak. Azok a fogalmak, amelyek ebben az élen járnak, a következőképpen sorolhatók fel.

  • Másolás (ismétlődő kód): Érvényes, ha vannak ismétlődő szakaszok, és ezt a kódszerkezetet másolhatja és beillesztheti. Lásd még: Ne ismételd meg magad (SZÁRAZ) elv
  • Ismeretlenség: Ez a fogalom felkelti a figyelmet, ha a kód értelmezhetetlen és nehezen olvasható.
  • Merevség: Változtatni nem lehet, még ha változtatnak is, sok helyen érintve lesz érvényes.
  • Bőbeszédű kód (szükségtelenül hosszú kód): Ez a koncepció akkor érvényes, ha túlbonyolítja az egyszerűbb módon végrehajtható műveletet.

Ha alaposan megvizsgálja a fenti fogalmakat és magyarázataikat, könnyen megértheti a kódszagokat.

Ebben a tartalomban az Ön számára Mi az a tiszta kód? Hogyan írjunk tiszta kódot? Mi a rossz kód? Mi az a kódszag? Sok kérdésre válaszoltunk, és részletesen elmagyaráztuk őket. Ön is hozzájárulhat tartalmunkhoz, ha véleményét és javaslatait a megjegyzés rovatban kifejti.

Gyakran Ismételt Kérdések

Összegyűjtöttünk néhány gyakran ismételt kérdést a tiszta kóddal kapcsolatban.

Mi az a kódolvashatóság?

Ha az írott kód könnyen olvasható és érthető az azt író és olvasó személy számára, akkor azt olvashatósági kódnak nevezzük.

Mi az a függőségi inverzió elve?

A függőségi inverzió elve Ennek megfelelően a magas szintű modulok nem függhetnek alacsony szintű moduloktól. A hely, ahol mindkét modulnak függnie kell, az absztrakciónak kell lennie. Lásd még: Szilárd elvek

Mi az a duplikált kód?

Ez akkor fordul elő, ha a kódot író személy sok kódot ismétel, és az összes írt kódot sokszor, különböző helyeken, kezelhetetlen módon használja fel. Ennek eredményeként a teljes szoftvert ki kell értékelni, szerkeszteni, és a részeit át kell írni.