Efter att ha jobbat som systemutvecklare i ett år nu har jag märkt hur viktigt det är att ha kodstandarder. Med tipsen som Robert C. Martin ger i nedanstående video får man kod som är mer läsbar, lättare att komma tillbaka till efter att man påbörjat något annat projekt, och lättare för andra utvecklare att ta över.
Hur lång ska en metod vara?
På 80-talet skulle en metod vara så lång att den fick plats på skärmen. På den tiden fick man plats med 24 rader varav 4 av dom användes av programmet man utvecklade i. Idag får vi plats med hundratals rader. Martin anser att metoden ska vara så liten att den endast gör en sak, och att man då kan hålla ner radantalet mellan 3 till 10 rader.
Metodnamn
Se till att metodnamnet förklarar vad metoden gör och den ska endast göra en sak. Var inte rädd för att namnet ska bli för långt, se till att använda en namnkonvention som tillåter flera ord i namnet.
If, else, while-satser, foreach och try catch
Koden i en if, else, while-sats, foreach och try catch ska vara max 1 rad lång och kalla på en annan metod. Detta för att hålla metoden liten och för att man dokumenterar vad som händer med hjälp av metodanropets namn.
Hur många argument ska en metod ta emot?
Det idealiska antalet argument en metod har är 0, och max är 3. Över detta antalet ska man se till att man passar runt ett objekt med värdena i istället.
Outargument
Använd inte out-argument alls. Man är van vid att man skickar in argument i en metod och tar emot det som returneras av den. Normalt förväntar vi oss inte att information kommer tillbaka genom argumenten.
Booleans i argument
Använd inte booleans i en metods argument. Då kommer metoden med stor säkerhet göra mer än en sak. En sak ifall du passar in true, och en annan ifall du passar in false. Även anropen till denna metod kommer bli svår att tolka. Martin använder exemplet DeleteEmployee(“Bob”, false, true); Man måste gå in i metoden för att se vad den gör beroende på de booleans man skickar in.
Kommentarer
Kommentera inte koden, metodnamnet ska förklara vad metoden gör tillräckligt bra. Kommentarer riskerar att bli utdaterade när man gör ändringar i metoden och lurar utvecklaren som kommer tillbaka till metoden efter en tid. Martin beskriver kommentarer som lögner just för att de sällan uppdateras när metoden uppdateras.
Bortkommenterad kod ska tas bort direkt. Den är bara i vägen. Den finns fortfarande i versionshanteringen och går att hämta ut när du vill.
Variabelnamn
Använd inte förtkortningar i namnen på variablar. Använd samma princip som i metodnamn