Kodekvalitet

Hvad det er

Kodekvalitet handler om, hvor godt kildekoden opfylder sit formål,
og hvor let andre kan forstå, kontrollere og ændre den. Tænk på en
lille funktion til fakturering. Den ene udgave finder det rigtige
beløb for demonstrationsordren, fordi ordren passer præcist til det
forløb, udvikleren havde i tankerne. Den anden angiver valutaen, har
én tydelig afrundingsregel og behandler en kreditering særskilt.
Begge kan bestå testen af en almindelig ordre. Den anden giver et
klarere udgangspunkt, når nogen skal undersøge en faktura, der er
blevet gjort indsigelse imod.

Korrekthed gælder også ved ugyldige inddata, gentagne forsøg og
delvist gennemførte handlinger. Læsbarhed handler om, hvorvidt en ny
person kan finde de beslutninger, der har betydning. Muligheden for
at ændre koden afhænger af, hvor meget et nyt krav påvirker, og om
virkningen kan efterprøves. En kort funktion kan beregne forkert
skat. En indviklet funktion kan regne rigtigt i dag, men gøre det
svært at kontrollere en ny valuta i morgen.

En kodegennemgang er én måde at vurdere de egenskaber på. Et
kvalitetsstop kan hindre, at en ændring går videre, når udvalgte
kontroller fejler. Teknisk gæld beskriver den fremtidige omkostning,
som en beslutning medfører. Kodekvalitet handler om kodens tilstand.
Googles regel for kodegennemgang gør spørgsmålet konkret ved at bede
den, der gennemgår ændringen, vurdere, om den forbedrer tilstanden i
den samlede kodebase.

Hvorfor det betyder noget

Kvaliteten bliver ofte synlig, når et krav ændrer sig. En tjeneste
beregner tilbud, udsteder fakturaer og foretager tilbagebetalinger.
Hvis hver handling regner den samme rabat ud for sig, kræver den
næste kampagne, at alle kopier findes og ændres. En afvigelse viser
sig måske først ved den første tilbagebetaling. Hvis reglen er
samlet ét kendt sted, og hvert kald sender sine oplysninger
tydeligt, kan holdet lettere overskue ændringen og vælge, hvad der
skal testes.

Brug beviser, der passer til risikoen. For pengebeløb kan man vælge
et tilfælde, hvor afrunding pr. linje giver et andet resultat end
afrunding af summen. For en handling, der kan gentages, undersøger
man, om endnu en anmodning udløser endnu en betaling. For en
beregning, der køres ved hvert køb, kan man måle svartiden ved
forventet belastning, inden man indfører en cache. Hver observation
siger noget om et afgrænset spørgsmål.

Der er også et spørgsmål om overlevering. Folk skifter opgave, og
den næste udvikler kender måske ikke modulets historie. Klare navne,
et eksempel, der kan køres, og en kort forklaring på en usædvanlig
begrænsning gør det muligt selv at efterprøve en beslutning. Det er
lige vigtigt ved oplæring og ved fejlsøgning uden for normal
arbejdstid.

Sådan ser det ud i praksis

Antag, at virksomheden afrunder skatten på summen for hver
skattesats. En faktura har to linjer med en uafrundet skat på 0,005
valutaenheder hver. Afrundes hver linje til hundrededele, og rundes
et resultat præcis midt imellem op, bliver summen 0,02. Lægger man
først sammen og afrunder én gang, bliver den 0,01. Eksemplet er
lille nok til, at regnestykket kan efterprøves i hånden. Den
faktiske regel skal komme fra produktets krav og gældende regler.

Funktionens aftale med resten af systemet kan angive enheder og
regnerækkefølge. Mellemregningerne skal bevare den nødvendige
præcision. Gør grupperingen tydelig, og læg afrundingen på det
aftalte trin. En test med tallene ovenfor skelner de to regler. En
anden kan blande skattesatser, så en omskrivning ikke ved en fejl
erstatter grupperne med én samlet sum. Gælder der en særskilt regel
for tilbagebetalinger, hører der et særskilt eksempel til.

Følg det beløb, kunden får vist, sammenhold det med det eksporterede
beløb, og undersøg kaldet ved en tilbagebetaling. Gamle fakturaer
skal bevare beløbene fra udstedelsen. En test af hele forløbet
kontrollerer, at de rette enheder når frem til beregningen. En test
af selve funktionen viser resultatet for kendte inddata.

I vores note om at sælge den sidste billet én gang bruges samme
metode på beholdningen. Noten opstiller en formel, som beholdningen
altid skal opfylde, beskriver samtidige forsøg og foreslår at
overvåge formlen i drift. Den gør det muligt at finde det krav, der
skal holde, selv når forskellige handlinger bliver ændret.

Hvor det går galt

Et mål kan forveksles med et bevis. Dækning viser, hvilke linjer
eller grene en test kørte. En test kan stadig have den forkerte
afrundingsregel som forventet resultat. Et mål for kompleksitet kan
pege på noget, der fortjener nærmere læsning. Fordeler man en klar
sammenligning på flere uklare hjælpefunktioner, kan fejlsøgningen
blive vanskeligere. Nævn først den fejl, en ny måling skal afsløre,
og undersøg eksempler på begge sider af grænsen.

Omfanget af en oprydning er heller ikke et mål i sig selv. Et uklart
navn i en sjælden rapport har mindre rækkevidde end en tvetydig
betingelse, der styrer alle betalinger. Beskriv risikoen, skeln
mellem en nødvendig rettelse og en valgfri forbedring, og aftal,
hvornår spørgsmålet skal tages op igen. En fælles konvention og et
automatisk formateringsværktøj kan ofte løse en diskussion om
opsætning.

En lokal forbedring kan flytte problemet. En fælles rabatfunktion
passer, hvis flere kald faktisk bruger samme forretningsregel. Den
gør det sværere at forstå koden, hvis den skal gætte forskellen
mellem en fornyelse, en kampagne og en refusion. Find først de
inddata og betingelser, der er fælles. Del den stabile del, gør
forskellene tydelige, og efterprøv resultatet.

Læs mere

  * Googles kriterium for at godkende en kodeændring

  * Hvad Googles kodegennemgang ser efter

  * Enhedstest i Software Engineering at Google

hDenne side på nettet	URL:https://engineer.company/da/glossary/code-quality/	engineer.company	70
