Az előző cikkben (lásd: Design és tervminták: Kódátírás, újraírás, objektum-orientáltság) szó esett az elegáns, bejáratott módszerek, tervezési minták alkalmazásának fontosságáról, és arról, hogy mihez vezet az ad-hoc módon történő, dilettáns szoftverfejlesztés. A következőkben bemutatásra kerül néhány árulkodó jel, amely valószínűleg a kód gyatra minőségére utal.
- Ismétlődő, hasonló vagy teljesen azonos kódrészletek
A kódot többen tartják karban, a teljes rendszer kellő ismerete nélkül – vagy egyszerűen figyelmetlenség, lustaság.
Megoldás:
függvény kiemelése.
- Hosszú függvények
Hosszadalmas fejlesztések, karbantartások mellékterméke, meggondolatlanságra, kapkodásra utal.
Megoldás:
függvény szétbontása, a kód kiemelése segédfüggvényekbe.
- Terjengős osztályok
Szinte mindig arra utal, hogy a kód nincs rendesen átgondolva, és mindent egy osztályba tuszkoltak. Az osztályra túl sok feladat hárul, amire a tagváltozók magas száma is utal.
Megoldás:
átírása komoly körültekintést igényel, de meg lehet próbálkozni az alosztályokra bontással; bizonyos esetekben csak az újratervezés segít.
- Hosszú paraméterlisták
Az objektum-orientált nyelvekre nem jellemző, túl sok függőségre utal.
Megoldás:
A bemeneti paraméterek struktúrákba vagy segédstruktúrákba szervezése, teljes hívási lánc és a függőségek átgondolása.
- Sűrűn előforduló switch utasítások
Általában ugyanaz a switch több helyen is fellelhető szétszórva a kódban, ami karbantartási gondokat okozhat - elég, ha egy új típus felvételekor az egyik switch esetében kihagyjuk az új ág kiértékelését. Helyette: polimorfizmus.
- Aránytalanul sok megjegyzés
”Magyarázom a bizonyítványom” jelenség. Egy tiszta kód nem szorul állandóan magyarázásra. A félreértések elkerülése végett: a komment igenis hasznos dolog, csak ne essünk át a ló másik oldalára. Apropó kommentek - ez a téma is megérne egy misét, addig is egy
Tipp
A magyarázatokat érdemes megjelölni, erre szolgálnak például a következő címkék:
- TODO - akad itt még tennivaló
- FIXME - ez a kódrészlet hibás, sürgősen javításra szorul!
- XXX - működik ugyan, de nem a legszebb megoldás, illetve másképp nem lehet megoldani
- Minden változtatás végighullámzik a kódbázis jelentős részén
Az egyik legsúlyosabb ismérv a rossz kódra – a karbantarthatóság és az OO-jelleg megkérdőjelezhető.
Megoldás:
valószínűleg csak az újratervezés segíthet.
A következő cikkekben bemutatásra kerülnek azok a szoftverfejlesztési minták, amelyekről minden fejlesztőnek illik tudni, és segítenek elkerülni - többek között - a felsorolt problémákat is.
| < Előző | Következő > |
|---|
