Der findes som bekendt milliarder og atter milliarder linier af kildekode til alverdens it-systemer, men ikke al kode er skrevet lige godt.
Software-udviklere har ofte ret fastlagte holdninger til, hvad der gør en rå kode ‘god’ eller ‘dårlig,’ og det er langt fra altid, at de er enige.
Nogle ting er de imidlertid ret enige om, beretter Computerworlds amerikanske nyhedsbureau, der har gennemgået flere store udvikler-foraer for holdninger til ‘god’ og ‘dårlig’ kode.
1: Skal være nem at læse
Den måske vigtigste egenskab for ‘god’ kode er, at den skal være nem at læse, og dette er langt de fleste software-udviklere rørende enige i.
En letlæselig kode gør det nemt for andre udviklere at forstå, hvad koden handler om, og hvad meningen med den er.
“Efter min mening har udvikleren ikke været dygtig nok, hvis jeg ikke kan forstå hans hensigt i løbet af maksimalt fem minutter,” lyder det således fra en senior-udvikler – Luke Burnham – som Computerworlds amerikanske søstermedie har talt med.
“Computeren er ligeglad med variable navne eller mellemrum mellem linier, men det gør mennesker. Kode bliver skrevet én gang, men bliver læst hundredevis af gange,” siger han.
En anden softwareudvikler peger på, at ‘god’ kode betyder, at den skal være skrevet i en konsistens stil med ordentlige mellemrum, ordentligt indrykning og et godt flow samt med betegnelser, der ‘giver mening.’
Annonce:
Godt med gode kommentarer
Masser af kommentarer og forklaringer hører også til enhver god kode. Grunden er simpel: Gode kommentarer gør det nemmere hurtigt at forstå koden, og hvad hensigten med den er.
En udvikler understreger, at forklaringerne i kommentarfelterne ikke skal handle om, hvad en funktion eller kodesekvens gør, men hvorfor den gør det.
“Kommentarerne til god kode skal gøre det klart for andre, hvad der egentlig foregår i udviklerens hoved, mens han skriver koden,” skriver han.
Forklaringerne gælder i øvrigt over udvikleren selv, da ingen udvikler kan huske intentioner og planer til al den kode, som han har skrevet i tidernes løb.
Ordentlige kommentarer kan derfor være nyttige for udvikleren selv, hvis koden skal modificeres engang i fremtiden.
Den skal være simpel
God kildekode er enkel – også selv om den samlet ofte vil være i stand til at udføre komplekse opgaver.
Dermed vil gode udviklere være i stand til at løse opgaven uden at over-komplicere tingene, hedder det.
“Hvert stykke kode bør udføre én opgave, som til gengæld skal udføres perfekt. Dernæst skal det næste stykke kode udføre den næste opgave. De bedste løsninger er ofte de mest enkle,” lyder det fra en udvikler.
Desuden er der bred enighed om, at der er en sammenhæng mellem kode-kompleksitet og antallet af bugs.
Den skal være fleksibel
Der vil ofte være behov for, at funktionaliteten i et stykke kode justeres, udbygges eller genbruges andre steder, som tiden går, og behovene ændrer sig.
Derfor er det vigtigt, at koden er skrevet på en måde, så den er fleksibel.
Det er selvfølgelig umuligt at forudsige, hvad fremtidens behov bliver, men det kan godt lade sig gøre, at skrive koden, så den kan udbygges og justeres med så få ændringer som muligt.
Annonce:
Som en udvikler skriver, er det ultimative tegn på, at din kode er godt skrevet, hvis “den helt nye medarbejder får besked på at modificere den kode, som du skrev for seks måneder siden, og aldrig nogen sinde henvender sig til dig for at stille dig et spørgsmål.”
Den er nem at vedligeholde
Det er mere end sandsynligt, at din kode vil indeholde bugs – også selv om den er fantastisk godt skrevet – for det gør langt størstedelen af den kode, der bliver skrevet.
Og det betyder jo, at der skal rettes i koden, så bug’en kan fjernes.
Der er bred enighed blandt udviklerne om, at det er grundlæggende for ‘god’ kode, at den skal være nem at rette i.
“Al kode skal vedligeholdes, og den opgave skal være så nem som muligt,” lyder det fra en udvikler.
En anden skriver: “Den store forskel mellem kode, der bare fungerer og kode, der er fantastisk, er vedligeholdelses-venligheden ['maintainability'].”
Den skal fungere
Det er jo et ret oplagt kriterium for en god kode, men vi tager den ikke desto mindre med her.
For det er grundlæggende for enhver ‘god’ kode, at den skal fungere efter hensigten og løse alle de ønskede opgaver, som den er skrevet til.
Har vi glemt noget? Hvad synes du er et fællestræk for al god kode? Giv dit besyv med i debatfeltet herunder.
Læs også:
Verdens måske allerbedste og mest indflydelsesrige programmører
Leave a Reply