Kód felülvizsgálatok
Szerző: Mattias Karlsson
Kódellenőrzéseket kell végeznie. Miért? Mivel javítják a kód minőségét és csökkentik a hibák arányát. De nem feltétlenül azokból az okokból, amelyeket gondolhat.
Mivel lehet, hogy rossz tapasztalataik voltak a véleményekkel kapcsolatban, sok programozó hajlamos elutasítani a kódellenőrzéseket. Láttam olyan szervezeteket, amelyeknek minden kód megköveteléséhez hivatalos felülvizsgálat szükséges, mielőtt a produkcióba lépnének. Gyakran az építész vagy a fejlesztés vezetője végzi ezt az áttekintést, amely gyakorlat leírható úgy, hogy mindent áttekintő építész. A szoftverfejlesztési folyamat kézikönyvében szerepel, ezért a programozóknak be kell tartaniuk. Egyes szervezeteknek szüksége lehet ilyen merevségre és formális folyamatokra, de sokuknak nem. A legtöbb szervezetben ez a megközelítés nem produktív. A keresés során úgy érezheti, mintha a feltételes szabadlábon eljáró testület próbálná ki őket. Az ellenőröknek egyaránt szükségük van a kód elolvasására, valamint arra, hogy naprakészek maradjanak a rendszer minden részletével. A bírálók gyorsan szűk keresztmetszetekké válhatnak ebben a folyamatban, és a folyamat gyorsan elfajul.
A hibakódok kijavítása helyett a kódellenőrzések célja az ismeretek megosztása és a közös kódolási irányelvek kidolgozása kell, hogy legyen. A kód megosztása más fejlesztőkkel lehetővé teszi a kód közös tulajdonjogát. Ne korlátozza az áramlását, hagyja, hogy bármelyik csapattag átnézze a kódot a csapat többi tagjával. A hibák keresése helyett érdemes áttekinteni a kódot, hogy megpróbálja megtanulni és megérteni.
Legyen szelíd a kódellenőrzések során. Győződjön meg róla, hogy észrevételei konstruktívak és nem maró jellegűek. Vezessen be különféle szerepeket az áttekintő táblán, elkerülve, hogy a csapatban az idősebbek befolyásolják a kódellenőrzéseket. A szereppéldák között szerepelhet a dokumentációra összpontosító áttekintő, egy másik a kivételekkel és egy harmadik fél, amely funkcionalitást keres. Ez a megközelítés segít elosztani a vélemények terheit a csapattagok között.
Rendszeresen, heti egy napon ellenőrizze a kódot. Töltsön el pár órát a bíráló bizottságon. Forgassa a heti ellenőrzéseket egyszerű körmérkőzéssel. Ne felejtse el az egyes felülvizsgálati értekezleteken a szereplők közötti szerepváltást is. Vegyen be újoncokat a kódellenőrzésekbe. Lehet, hogy tapasztalatlanok, de legfrissebb egyetemi ismereteik más perspektívát nyújthatnak. Szakértőket von be tapasztalataik és tudásuk érdekében; gyorsabban és nagyobb pontossággal fogják azonosítani a hibára hajlamos kódot. A kódellenőrzések könnyebben folynak, ha a csapatnak vannak kódolási konvenciói, amelyeket eszközök ellenőriznek. Így a kódformátumot soha nem fogják megvitatni a kódellenőrző fórumon.
A kódellenőrzések szórakoztatása a siker legfontosabb tényezője. A vélemények a felülvizsgálat alatt álló személyekről szólnak. Ha a felülvizsgálati értekezlet fájdalmas vagy unalmas, akkor nehezebb lesz bárkit motiválni. Tegye informális kódellenőrzéssé, amelynek fő célja az ismeretek megosztása a csapattagok között. Hagyja a megjegyzéseket, és inkább hozzon süteményt vagy barna táskás ebédet.
Fordítás: Espartaco Palma
Espartaco Palma összeállítása (@esparta).
Büszkén házigazdája a githubnak