Skip to the content

Sju tips på att koda så andra förstår 

Många utvecklare har en tendens att bara fokusera på att koden gör det den ska. Att koden fungerar är viktigast naturligtvis, men nästan lika viktigt är att andra kan läsa och förstå din kod.

Jag antar att en stor del av din arbetstid går åt till att läsa andras kod, samt att du ofta undrar hur hjärnan fungerar på den utomjording som tidigare arbetat med den kod du nu fått i knät. Du kan lita på att andra tänkt likadant om din kod. Pressade deadlines tvingar ibland oss utvecklare att göra kortsiktiga val Gör inte det. Du kommer få betala tillbaka längre fram eller så tvingas någon annan att betala tillbaka - dyrt.

Nästa gång du kodar, kanske redan efter att du läst det här blogginlägget, försök lägga lite extra energi på att skriva kod som är lättläst. Det behöver inte vara särskilt svårt, det blir snabbt en god vana att skriva kod som andra enkelt kan förstå och i det långa loppet kommer du spara tid.

1. Koda som Skogsmulle

Som sexåring gick jag i Mulleskolan. Det gjorde intryck på mig. Vi sjöng högljutt och falskt det mantra som för alltid fastnat i mitt huvud:

"Man ska aldrig, aldrig, aldrig kasta papper! Alltid, alltid, alltid plocka upp!".

Om vi hittade skräp på rastplatsen städade vi glatt undan detta, och att skräpa ner efter sig fanns inte på kartan. Detta är den viktigaste regeln att följa även när du kodar. Lämna alltid koden snyggare än du hittade den. Din kod ska vara snygg men du ska även städa i andras kod. Om du inte gör detta kommer koden snart vara ohållbart stökig.

Vad är då snygg kod? Fortsätt läsa min vän.

2. Läsbarhet

Använd vettiga namn på klasser, variabler och funktioner. Undvik förkortningar. Du ska enkelt kunna läsa på namnet vad en klass är till för och om en funktion gör något eller returnerar något.

3. Ansvar för en uppgift

En klass, variabel eller funktion ska bara ha EN uppgift. Det gör att din kod blir lättare att följa, förstå och felsöka. Det underlättar även för dig att ge koden vettiga namn.

4. Håll det kort

Skriv korta funktioner (runt 20 rader) och undvik för många argument till en funktion (helst mindre än 5). Många korta funktioner, med vettiga namn, ger en bra överblick över din kod. Du kan snabbt få en uppfattning om vad koden gör. Samma sak gäller för filer, håll dem korta (ca 300 rader). Håll även dina rader korta (ca 120 tecken).

Storleken HAR betydelse.

5. Duplicera inte

Ctrl+C och Ctrl+V ska inte användas för att kopiera stora sjok av kod, även om det kanske är frestande. Om du vill ha samma logik på ett annat ställe, gör en funktion som du sedan återanvänder. Om två klasser liknar varandra till stor del, låt dem istället ärva gemensamma egenskaper och metoder från en basklass.

Du har nu hälften så mycket kod att underhålla. Om du fortsätter i den här takten har du snart inget jobb alls kvar att göra.

6. Undvik kommentarer

Kommentarer är onödiga om du skriver kod som är lättläst redan från början. Kommentarer blir också snabbt inaktuella, när någon ändrat i koden men inte ändrat kommentaren.

Förklara koden med hjälp av meningsfulla och informativa namn på funktioner och variabler istället. Det räcker fint.

7. Var konsekvent

Se till att din kod alltid är snyggt indenterad, det blir mycket enklare att läsa. Tänk på hur du använder stora och små bokstäver (casing), enligt best practice för det språk du kodar i. Använd radbrytningar, dvs en tom rad, som ett sätt att dela upp din kod i sektioner. Kod helt utan dessa radbrytningar är mycket svårare att läsa.

Använd alltid måsvingar. Här kommer någon tycka annorlunda, jag vet, men om du är konsekvent med att använda måsvingar ramar du in din kod på ett snyggt sätt. 

Hälsningar Jonas Olsson, Tech Lead Spot On

Spot On