IT blog
Szakmai tanácsok, új módszertanok, hogy napról-napra jobb fejlesztővé válhass.

Code review: 5 tipp, hogy jobban csináljuk

IT 2015. szeptember 1. Farkas Gábor

Jeff Atwood szerint egymás forráskódjának szakértői véleményezése (peer review) az egyik legfontosabb dolog, amit a kódminőség általános javításáért tehetünk. Sokan azonban mégis szkeptikusak, ám ez főleg a módszer rossz alkalmazásából fakad. Ebben a posztban néhány pontban összefoglaljuk, mire érdemes odafigyelni, hogy a code review folyamat hatékony és zökkenőmentes legyen.

Code review: 7 tipp, hogy jobban csináljuk

Automatizáljuk amit lehet, és csak a fontos dolgokra figyeljünk

Nem érdemes a drága időt stilisztikai és formázási dolgok ellenőrzésére pazarolni, erre rengeteg eszköz létezik. Ami fontos, hogy a kód helyes, karbantartható és érhető legyen. Természetesen ennek egy nagyon fontos része a formázás és a stílus, de ezek ellenőrzését bízzuk inkább automatizált eszközökre.

Mindenki véleményezzen kódot

Természetesen vannak fejlesztők, akiknek jobban megy más kódjának a véleményezése, másoknak nehezebben. Azonban ezt figyelembe véve is nagyon fontos, hogy minden fejlesztő rendszeresen véleményezze valaki más kódját. Ez egyrészt a fejlődést szolgálja, másrészt így nem alakul ki az a rossz hozzállás, mely szerint van egy "másik oldal", akinek az egyetlen feladata, hogy "az én kódomba belekössön". Ha mindenki aktívan részt vesz a folyamatban, csak egyetlen oldal lesz.

Ne féljünk azt mondani, hogy "ezzel minden OK"

A code review közben néha előfordul, hogy a véleményező egyfajta nyomást érez arra, hogy mindenképpen valamilyen hibát találjon a véleményezendő kódban. Ez semmiképp sem jó hozzállás, nem kell túlságosan kötekedőnek lennünk — ha úgy érezzük, nem változtatnánk semmit az addot kódrészletben, ám legyen.

Egyszerre csak keveset, és rövid ideig

Számos tanulmány erősíti azt a tényt, mely szerint egy óra folyamatos kódvizsgálat után meredeken csökken a hatékonyság a folyamatos koncentrációból fakadó fáradtság miatt. Ezt érdemes figyelembe venni, és egy-egy sessiont lehetőleg egy óra alatt tartani. Emellett az is előnyös (persze nem csak a véleményezőn múlik), hogy egy-egy véleményezett kódrészlet max. 200 sor körül maradjon (de semmiképp se menjen 400 fölé).

Használjunk ellenőrző listát

A code review folyamatot némileg formalizálhatjuk, ha egy közös checklistet használunk, amin az ellenőrizendő dolgokat tartjuk számon. Ebben olyan pontok szerepelhetnek, mint például könnyen érthető-e a kód egy másik fejlesztő számára, vagy tartalmaz-e a kód redundáns vagy ismétlődő részleteket, stb. Egy ilyen lista biztosítja, hogy mindenki tudja, mire kell fókuszálnia, és segít megszüntetni bizonyos gyakori hibákat.

A code review egy kiváló és olcsó eszköz a magas kódminőség fenntartására, és ha a fentieket észben tartjuk és alkalmazzuk, még jobban kiaknázhatjuk az előnyeit.

Nektek mi a tapasztalatotok a code review-val? Alkalmazza a jelenlegi cégetek? Ha igen, mennyire formalizált, és mennyire segít a gyakori hibák megtalálásában?

Címkék

Hasonló cikkek