Kodaj recenzoj por fariĝi pli bona programisto
Laŭ mia sperto, partopreni en koda revizio estas la plej efika maniero por niveliĝi kiel programisto. Se vi estas la kreinto de la reviziitaj ŝanĝoj, vi povas ricevi rektajn komentojn de viaj kolegoj. Kaj se vi estas unu el la recenzistoj, vi povas lerni malsamajn alirojn, pri kiuj vi eble ne pensis pri kiel solvi efektivigojn.
Sed ĝuste doni kaj ankaŭ kompreni kodan revizion estas lerteco, kiun oni devas lerni. En ĉi tiu artikolo, mi simple listigos kelkajn aspektojn, kiujn mi konsideras kiam mi donas kaj ricevos kodajn recenzojn. De mia vidpunkto, ili pruvis esti la ĝusta elekto por kunlabora kaj bonveniga evolumedio.
Kion mi difinas kiel bonan kodon
Memoru, ke estas nenio pli konstanta ol provizora solvo.
La sekvaj ŝlosilaj mezuroj gvidas min kiam mi skribas kaj revizias kodon.
- la kodo estas konservebla, ekz. neniuj hakoj aŭ solvoj tamen bone dokumentitaj
- la kodo estas facile legebla, tiel rezoni pri ĝi estas multe pli facila
- la kodo estas testebla, tiel plu plibonigante la antaŭajn du punktojn
Kiel doni kodon revizion
Estu humila
Malpravi ne estas problemo. Insisti ke vi pravas kvankam vi objektive ne estas problemo. Ĉiam memoru, ke vi eble maltrafos ion aŭ simple miskomprenis la kodon. Estu malfermita por forpuŝo kaj estu humila por la ŝanco lerni ion novan.
Kodrecenzoj ne estas personaj
Memoru: la kodo venas unue. Vi povus revizii ies kodon en streĉa situacio, kie vi ambaŭ ne emas paroli unu kun la alia, aŭ ĝenerale malkonsentas pri la nuna maniero kiel aferoj funkcias.
Kodaj recenzoj ne estas la loko por ellasi iom da vaporo aŭ por repagi frustriĝojn. La sola celo de recenzoj estas objektive plibonigi la kodkvaliton. La kodo, kiun vi revizias kaj kiu estos kunfandita, estas la sekva hereda kodo, tial gravas lasi personajn aferojn flanken kaj provizi objektivan revizion, negrave kiu estas la recenzito.
Opinioj ne estas recenzoj
Ĉefa diferenco inter bona recenzo kaj nur komento estas, ke recenzoj forlasas opiniojn. Ekzemple, ne gravas kiel aspektas la kodstilo, kondiĉe ke ĝi estas konservebla, facile legebla kaj testebla. Se vi ne certas, ĉu via recenzo estus opiniema, simple aldonu rimarkon por ke vi povu diskuti la aferon kun via kolego.
Bonaj recenzoj kondukas al bonaj diskutoj
Defii revizion povas konduki al grandaj scio-translokigoj inter programistoj. Antaŭfiksita recenzo ne estu traktata kiel fina komento sed prefere kiel deirpunkto por diskutoj por akiri la tutan bildon. Vi ambaŭ eble maltrafos ion kaj diskuti la kritikon nur povas plibonigi viajn komprenojn.
Limdatoj ne gravas
Ne ĉiam facile devigi, sed transsalti kodajn recenzojn eble povas krei grandan teknikan ŝuldon, kiun neniu volos purigi. Gravas konservi la necesan disciplinon por doni ĝisfundajn kodajn recenzojn eĉ se vi aŭdas la horloĝon tiktaki. Vi eble estos la sekva programisto laboranta pri ĉi tiu malordo!
Uzu ligilojn por referencoj
Kompari la reviziitan kodon kun ekzistanta okazas sufiĉe ofte. Tial gravas ĝuste inkluzivi referencojn per ligiloj. Nur mencii la proksimuman lokon kie troviĝas la referencita kodo ne tranĉas ĝin.
Uzu la funkcion de via fontkontrolo por reliefigi kodon sur ekzistanta branĉo kaj uzu la kreitajn URL-ojn en via recenzo por referenco. La sama validas por ekstera dokumentado, ekzemple ĉe MDN.
Kiel legi kodan recenzon
Ĉiuj antaŭaj
Legi kodajn recenzojn pri via kodo igas vin pli bona programisto kiam vi sekvas ĉiujn menciitajn punktojn. Estu humila, ne prenu kritikon persone kaj strebu kompreni kion recenzo montras por pli bone kompreni la grandan bildon.
Persona opinio pri kiel esti objektiva
Ĉi tiu artikolo reflektas mian personan aliron pri kodaj recenzoj. La skizitaj punktoj estas nur kulmino de mia sperto kiel programisto en teamoj grandaj kaj malgrandaj, kaj loke kaj ankaŭ internaciaj. Ili pruvis funkcii, kondukante al pli bona kodo kaj donante al mi la ŝancon rekte lerni de aliaj.
