Kode resensies om 'n beter ontwikkelaar te word
Volgens my ervaring is deelname aan 'n kode-oorsig die doeltreffendste manier om 'n vlak as 'n ontwikkelaar te bereik. As jy die skepper van die hersiene veranderinge is, kan jy direkte terugvoer van jou kollegas kry. En as jy een van die beoordelaars is, kan jy verskillende benaderings leer waaraan jy dalk nie gedink het oor hoe om implementerings op te los nie.
Maar om 'n kode-oorsig korrek te gee en ook te verstaan, is 'n vaardigheid wat aangeleer moet word. In hierdie artikel sal ek bloot 'n paar aspekte lys wat ek oorweeg wanneer ek kode-resensies gee en ontvang. Vanuit my oogpunt het hulle bewys dat hulle die regte keuse is vir 'n samewerkende en verwelkomende ontwikkelingsomgewing.
Wat ek definieer as goeie kode
Onthou dat daar niks meer permanent is as 'n tydelike oplossing nie.
Die volgende sleutelmaatstawwe lei my wanneer ek kode skryf en hersien.
- die kode is onderhoubaar, bv. geen hacks of oplossings, maar goed gedokumenteer nie
- die kode is maklik leesbaar, dus is dit baie makliker om daaroor te redeneer
- die kode is toetsbaar, wat die vorige twee punte verder verbeter
Hoe om 'n kode-oorsig te gee
Wees nederig
Om verkeerd te wees is nie 'n probleem nie. Om aan te dring dat jy reg is al is jy objektief nie, is 'n probleem. Hou altyd in gedagte dat jy dalk iets mis of bloot die kode verkeerd verstaan het. Wees oop vir terugslag en wees nederig vir die kans om iets nuuts te leer.
Kode resensies is nie persoonlik nie
Onthou: die kode kom eerste. Jy kan iemand se kode hersien in 'n gespanne situasie waar albei van julle nie in die bui is om met mekaar te praat nie, of oor die algemeen verskil oor die huidige manier waarop dinge werk.
Kode-resensies is nie die plek om 'n bietjie stoom af te laat of om frustrasies terug te betaal nie. Die enigste doel van resensies is om die kodekwaliteit objektief te verbeter. Die kode wat jy hersien en wat saamgevoeg sal word, is die volgende erfeniskode, daarom is dit belangrik om persoonlike dinge eenkant te laat en 'n objektiewe resensie te verskaf, maak nie saak wie die beoordelaar is nie.
Menings is nie resensies nie
'n Sleutelverskil tussen 'n goeie resensie en net 'n opmerking is dat resensies menings uitlaat. Dit maak byvoorbeeld nie saak hoe die kodestyl lyk nie, solank dit onderhoubaar, maklik leesbaar en toetsbaar is. As jy nie seker is of jou resensie opinig sal wees nie, voeg bloot 'n opmerking by sodat jy die punt met jou kollega kan bespreek.
Goeie resensies lei tot goeie besprekings
Om 'n resensie uit te daag, kan lei tot groot kennisoordragte tussen ontwikkelaars. 'n Gegewe resensie moet nie as 'n finale opmerking beskou word nie, maar eerder as 'n beginpunt vir besprekings om die geheelbeeld te kry. Albei van julle mis dalk iets en om die kritiek te bespreek kan net julle insigte verbeter.
Spertye maak nie saak nie
Nie altyd maklik om af te dwing nie, maar om kode-resensies oor te slaan, kan moontlik 'n groot tegniese skuld skep wat niemand bereid sal wees om skoon te maak nie. Dit is belangrik om die nodige dissipline te handhaaf om deeglike kode-resensies te gee selfs al hoor jy die horlosie tik. Jy is dalk die volgende ontwikkelaar wat aan hierdie gemors werk!
Gebruik skakels vir verwysings
Die vergelyking van die hersiene kode met bestaande een gebeur redelik gereeld. Dit is dus belangrik om verwysings korrek in te sluit via skakels. Om slegs die benaderde plek te noem waar die verwysde kode geleë is, sny dit nie.
Gebruik jou bronbeheerfunksie om kode op 'n bestaande tak uit te lig en gebruik die geskepde URL's in jou resensie vir verwysing. Dieselfde geld vir eksterne dokumentasie, byvoorbeeld op MDN.
Hoe om 'n kode-oorsig te lees
Al bogenoemde
Die lees van koderesensies van jou kode maak jou 'n beter ontwikkelaar as jy al die bogenoemde punte volg. Wees nederig, moenie kritiek persoonlik opneem nie en streef daarna om te verstaan wat 'n resensie uitwys om die groter prentjie beter te verstaan.
'n Persoonlike opinie oor hoe om objektief te wees
Hierdie artikel weerspieël my persoonlike benadering oor koderesensies. Die punte wat uiteengesit is, is net 'n hoogtepunt van my ervaring as 'n ontwikkelaar in spanne groot en klein, beide plaaslik sowel as internasionaal. Hulle het bewys dat dit werk, wat tot beter kode gelei het en my die geleentheid gegee het om direk by ander te leer.
