# Kodekvalitet

## Hva det er

Kodekvalitet handler om hvor godt kildekoden gjør det den skal, og hvor lett andre kan forstå, kontrollere og endre den. Tenk på en liten funksjon for fakturering. Den ene utgaven gir riktig beløp for eksempelbestillingen fordi den følger akkurat det forløpet utvikleren hadde i tankene. En annen utgave oppgir valutaen, samler avrundingsregelen og håndterer kreditnotaer uttrykkelig. Begge kan bestå en test av en vanlig bestilling. Den andre gir et bedre utgangspunkt for den som må undersøke en omstridt faktura.

Korrekthet gjelder også for ugyldige inndata, gjentatte forsøk og delvis utførte handlinger. Lesbarhet handler om hvilke vesentlige valg den neste leseren kan forstå ut fra koden. Endringsmuligheten avhenger av hvor mye et nytt krav påvirker, og om følgene kan etterprøves. En kort funksjon kan regne feil skatt. En innviklet funksjon kan gi rett svar i dag og gjøre det vanskelig å kontrollere en ny valuta i morgen.

En kodegjennomgang bidrar til å vurdere disse egenskapene i en konkret endring. En kvalitetsport kan stoppe en endring når bestemte kontroller feiler. Teknisk gjeld beskriver fremtidige kostnader som følger av et valg. Kodekvalitet handler om selve tilstanden til koden. Googles regel for gjennomgang gjør vurderingen praktisk ved å spørre om den enkelte endringen gjør kodebasen som helhet bedre.

## Hvorfor det er viktig

Kvaliteten merkes gjerne når et krav endrer seg. En tjeneste setter opp pristilbud, sender fakturaer og tilbakebetaler penger. Hvis alle tre handlingene har hver sin utgave av samme rabattregel, må hver kopi finnes og endres ved neste kampanje. Avviket blir kanskje synlig først ved første tilbakebetaling. Med en felles regel på et kjent sted og tydelige inndata for hvert kall kan den som gjennomgår endringen, lettere se hvilke forløp som bør testes.

Velg belegg etter risiko. Ved beregning av penger kan et eksempel vise forskjellen på å avrunde hver linje og totalen. For en handling som kan gjentas, bør man undersøke om den andre forespørselen fører til et nytt trekk. Hvis beregningen kjøres ved alle kjøp, er det verdt å måle svartiden under forventet belastning før man innfører en hurtigbuffer. Hver observasjon gir grunnlag for en konklusjon innenfor bestemte vilkår.

Kvalitet hjelper også når arbeidet skal overtas. Folk bytter prosjekt, og den som leser en endring, kjenner kanskje ikke historien til modulen. Tydelige navn, et eksempel som kan kjøres og en kort forklaring på en uvanlig begrensning gjør det mulig å kontrollere en beslutning uten å vente på forfatteren. Det er nyttig både ved opplæring og ved feilsøking utenfor normal arbeidstid.

## Slik ser det ut i praksis

Anta at en virksomhet avrunder avgiften etter å ha summert beløpene for hver sats. En faktura med to linjer har en uavrundet avgift på 0,005 valutaenheter per linje. Avrunder man hver linje til hundredeler, med avrunding opp for verdier nøyaktig midt imellom, blir summen 0,02. Summerer man først og avrunder én gang, blir beløpet 0,01. Tallene kan sjekkes uten et regneark. Regelen i en virkelig faktura må komme fra produktkravene og de gjeldende bestemmelsene.

Spesifiser hvilke enheter funksjonen forventer og i hvilken rekkefølge den regner. Mellomregningene må bevare nødvendig presisjon. Gjør grupperingen synlig og utfør avrundingen på avtalt trinn. En test med tallene ovenfor skiller de to reglene. En annen test med ulike satser kan hindre at en senere omskriving erstatter gruppene med én felles sum. En egen regel for tilbakebetaling trenger et eget eksempel.

Følg beløpet som vises til kunden, beløpet som eksporteres, og kallet som utføres ved en tilbakebetaling. Gamle fakturaer skal beholde beløpene som ble lagret ved utstedelsen. En test av hele forløpet viser om kallene leverer riktige enheter. En isolert test viser hvilket svar selve beregningen gir for kjente verdier.

I notatet vårt om å selge den siste billetten én gang brukes samme fremgangsmåte på lagerbeholdning. Notatet beskriver en likhet som alltid skal gjelde, skisserer tester med samtidige forsøk og foreslår overvåking av likheten i drift. Den gir et konkret krav som må bevares når forskjellige handlinger blir endret.

## Hvor det går galt

En målbar indikator kan bli behandlet som en garanti. Dekning viser hvilke linjer eller grener en test kjørte. Dersom testen forventer feil avrundingsregel, kan den likevel passere. Et kompleksitetsmål kan peke ut kode det er verdt å lese. Å dele en tydelig sammenligning mellom flere utydelige hjelpefunksjoner kan likevel gjøre feilsøkingen verre. Avklar hvilken konkret feil et mål skal oppdage og undersøk tilfeller på begge sider av grensen.

Oppryddingen kan også få feil prioritet. Et uklart navn i en sjelden rapport og et tvetydig vilkår for alle betalinger har ulike konsekvenser. Beskriv risikoen, skill nødvendige rettelser fra valgfrie forbedringer, og avtal når spørsmålet bør vurderes igjen. Uenighet om oppsett kan ofte løses med en felles regel og et formateringsverktøy.

En lokal forbedring kan flytte problemet. En felles rabattfunksjon passer når flere kall faktisk følger samme regel. Hvis funksjonen må gjette hvilken politikk som gjelder for fornyelser, kampanjer og refusjoner, blir den mindre forståelig. Finn først hvilke inndata og vilkår som er felles. Del den stabile delen, behold forskjellene synlige og gjør resultatet mulig å kontrollere.

## Les mer
* Googles standard for å godkjenne en kodeendring
* Hva Google ser etter i en kodegjennomgang
* Enhetstesting i Software Engineering at Google

=> /nb/notes/selling-limited-stock-without-overselling/ notatet vårt om å selge den siste billetten én
gang
=> https://google.github.io/eng-practices/review/reviewer/standard.html Googles standard for å godkjenne en
  kodeendring
=> https://google.github.io/eng-practices/review/reviewer/looking-for.html Hva Google ser etter i en
  kodegjennomgang
=> https://abseil.io/resources/swe-book/html/ch12.html Enhetstesting i Software Engineering at
  Google

=> https://engineer.company/nb/glossary/code-quality/ Denne siden på nettet
