Minden kód örökölt kód

Hogyan írjunk “jó örökölt kódot”

Íme néhány gyors kiindulási pont a jó örökölt kód írásához. A kódot sokkal könnyebb írni, mint olvasni, és a problémák javításának legjobb módja, ha nem hozunk létre problémákat.

Írd kevesebb kódot

Kevesebb kód = kevesebb potenciális hiba = kevesebb karbantartandó = kevesebb “rossz örökség”.

A kevesebb kód írása tekinthető a kód általános javításának legfontosabb módjának. A DRY elv természetes következményének és elsődleges eszközének tekinthető annak, hogy kevesebbet írjunk és többet érjünk el.

Kerüljük a // TODO és // FIXME

A // TODO vagy // FIXME írását vörös zászlónak és kódszagnak kell tekinteni.

Ha ezeket a megjegyzéseket lefordítjuk a tényleges jelentésükre, akkor a “TODO” a “technikai adósság létrehozását”, a “FIXME” pedig a “szándékosan írok hibát” jelenti.

Lehetnek ritka kivételek, amikor egy megoldás elhalasztása felülmúlja a mostani megoldás előnyeit, de általában a TODO-t és a FIXME-t a minimumra kell szorítani.

A bevált idiómák előnyben részesítése a csúcstechnológiákkal szemben

Ez ellentmondásosnak tűnhet… a csúcstechnológiák használata “újszerűbbé” teszi a kódot, igaz? Nos, igen, de egyben azt is eredményezi, hogy gyorsabban elavulhat.

Az új programozóknak is nehezebb dolguk lesz a dolgok megértésével. Ha a kódot bevált idiómák és keretrendszerek használatával írják, valószínűleg könnyebben olvasható, és nagyobb eséllyel működik hosszabb távon is.

Mindig jobb állapotban hagyd a kódot, mint ahogyan találtad

Az elején említett “ne írd újra” mondattal ellentétesnek tűnhet, azonban a folyamatos fejlesztés és refaktorálás különbözik a jelentős újraírástól.

Próbálj meg hozzászokni a dolgok fokozatos és inkrementális javításához. Néha valóban szükség van egy nagy refaktorálásra vagy átírásra, de ennek üzleti értékét gondosan mérlegelni kell más prioritásokkal szemben.

Folyamatosan fejlődj programozóként

Olvass könyveket, olvass blogbejegyzéseket, olvasd mások kódját, gondosan gondolkodj a tervezésről és a programozási gyakorlatokról. Tudatosan gondolkodj a kódodon, és gondolkodj azon, hogyan javíthatnál rajta.

Ahelyett, hogy az előző programozót hibáztatnád, amiért rossz örökséget hagyott maga után, inkább ügyelj arra, hogy ne te legyél az a programozó, aki új örökséget hoz létre.

Vélemény, hozzászólás?

Az e-mail-címet nem tesszük közzé.