Kódellenőrzés, hogy jobb fejlesztő lehessen
Tapasztalataim szerint a kódellenőrzésben való részvétel a leghatékonyabb módja annak, hogy fejlesztői szintre lépj. Ha Ön a felülvizsgált módosítások létrehozója, közvetlen visszajelzést kaphat kollégáitól. És ha Ön a felülvizsgálók egyike, különböző megközelítéseket tanulhat meg a megvalósítások megoldására vonatkozóan, amelyekre talán nem is gondolt.
De a kód áttekintésének helyes megadása és megértése olyan készség, amelyet meg kell tanulni. Ebben a cikkben egyszerűen felsorolok néhány szempontot, amelyeket figyelembe veszek a kódértékelések adásakor és fogadásakor. Az én nézőpontom szerint a megfelelő választásnak bizonyultak egy együttműködő és barátságos fejlesztési környezethez.
Amit jó kódnak definiálok
Ne feledje, hogy nincs tartósabb, mint egy ideiglenes megoldás.
A következő kulcsfontosságú mérőszámok vezetnek a kód írása és áttekintése során.
- a kód karbantartható, pl. nincs feltörés vagy kerülő megoldás, bármennyire is jól dokumentálják
- a kód könnyen olvasható, így sokkal könnyebb az érvelés
- a kód tesztelhető, így tovább javítva az előző két pontot
Hogyan adjunk áttekintést a kódról
Alázatosnak lenni
Tévedni nem probléma. Problémát jelent ragaszkodni ahhoz, hogy igazad van, még akkor is, ha objektíve nincs. Mindig tartsa szem előtt, hogy esetleg kihagyott valamit, vagy egyszerűen félreértette a kódot. Legyen nyitott a visszalépésre, és legyen alázatos a lehetőség iránt, hogy valami újat tanuljon.
A kód áttekintése nem személyes
Ne feledje: a kód az első. Egy feszült helyzetben átnézheti valaki kódját, amikor mindkettőtöknek nincs kedve beszélgetni egymással, vagy általában nem értenek egyet a dolgok jelenlegi működésével kapcsolatban.
A kódértékelések nem a megfelelő hely a gőz kiengedésére vagy a frusztráció megtérítésére. A felülvizsgálatok egyetlen célja a kód minőségének objektív javítása. Az Ön által ellenőrzött és összevonandó kód a következő örökölt kód, ezért fontos, hogy a személyes dolgokat félretegye, és objektív áttekintést adjon, függetlenül attól, hogy ki a véleményező.
A vélemények nem vélemények
A fő különbség a jó értékelés és a puszta megjegyzés között az, hogy a vélemények elhagyják a véleményeket. Például nem mindegy, hogyan néz ki a kódstílus, amennyiben karbantartható, könnyen olvasható és tesztelhető. Ha nem biztos abban, hogy véleménye véleményező lenne-e, egyszerűen fűzzön hozzá egy megjegyzést, hogy megbeszélhesse a kérdést kollégájával.
A jó vélemények jó vitákhoz vezetnek
A felülvizsgálat megkérdőjelezése nagyszerű tudásátadáshoz vezethet a fejlesztők között. Egy adott áttekintést nem szabad végső megjegyzésként kezelni, hanem inkább kiindulópontként kell kezelni a megbeszélésekhez a teljes kép kialakításához. Előfordulhat, hogy mindkettőtöknek hiányzik valami, és a kritika megvitatása csak javíthatja belátásait.
A határidők nem számítanak
Nem mindig könnyű végrehajtani, de a kód áttekintésének kihagyása nagy technikai adósságot okozhat, amelyet senki sem lesz hajlandó felszámolni. Fontos betartani a szükséges fegyelmet, hogy alapos kódellenőrzést adhasson, még akkor is, ha hallja az óra ketyegését. Lehet, hogy Ön lesz a következő fejlesztő, aki ezen a káoszon dolgozik!
Használjon hivatkozásokat a hivatkozásokhoz
Az áttekintett kód összehasonlítása a meglévővel elég gyakran előfordul. Ezért fontos, hogy a hivatkozásokat a hivatkozásokon keresztül helyesen helyezze el. Ha csak a hivatkozott kód hozzávetőleges helyét említi, az nem vágja ki.
A forrásvezérlő funkció használatával jelölje ki a kódot egy meglévő ágon, és referenciaként használja az áttekintésben létrehozott URL-eket. Ugyanez vonatkozik a külső dokumentációra is, például az MDN-en.
Hogyan kell elolvasni a kód áttekintését
A fentiek mindegyike
Ha elolvassa a kóddal kapcsolatos kódellenőrzéseket, akkor jobb fejlesztő lesz, ha követi az összes fent említett pontot. Légy alázatos, ne vedd személyesen a kritikát, és törekedj arra, hogy megértsd, mire mutat rá az áttekintés, hogy jobban megértsd a teljes képet.
Személyes vélemény arról, hogyan legyünk tárgyilagosak
Ez a cikk a kódellenőrzésekkel kapcsolatos személyes megközelítésemet tükrözi. A felvázolt pontok csak betetőzéseim a kisebb és nagyobb csapatokban végzett fejlesztői tapasztalatomnak, mind helyi, mind nemzetközi szinten. Bebizonyították, hogy működnek, jobb kódhoz vezettek, és lehetőséget adnak számomra, hogy közvetlenül tanuljak másoktól.
