Hur man skriver ”bra äldre kod”
Här är några snabba utgångspunkter för att skriva bra äldre kod. Kod är mycket lättare att skriva än att läsa, och det bästa sättet att åtgärda problem är att inte skapa dem.
Skriv mindre kod
Mindre kod = mindre potential för buggar = mindre att underhålla = mindre ”dåligt arv”.
Att skriva mindre kod kan ses som det enskilt viktigaste sättet att förbättra koden i allmänhet. DRY-principen kan ses som en naturlig följd och ett primärt sätt att skriva mindre och uppnå mer.
Undvik // TODO och // FIXME
Att skriva // TODO eller // FIXME bör ses som en röd flagga och en kodlukt.
Om vi översätter dessa kommentarer till deras egentliga innebörd kan ”TODO” översättas till ”skapa teknisk skuld” och ”FIXME” kan översättas till ”jag skriver avsiktligt ett fel”.
Det kan finnas sällsynta undantag där uppskjutandet av en lösning uppväger fördelarna med att lösa problemet nu, men i allmänhet bör TODO och FIXME hållas till ett minimum.
Företräcka etablerade idiom framför den senaste tekniken
Detta kan tyckas motsägelsefullt… att använda spetstekniker gör koden mer ”ny”, eller hur? Ja, men det skapar också en potential att bli föråldrad snabbare.
Det ger också nya programmerare svårare att förstå saker och ting. Om koden är skriven med hjälp av etablerade idiom och ramverk är den troligen lättare att läsa och har större chans att fungera längre in i framtiden.
Lämna alltid koden i ett bättre skick än du hittade den
Detta kan tyckas motsäga det ”ingen omskrivning” som nämndes i början, men kontinuerlig förbättring och refaktorisering skiljer sig från att göra en betydande omskrivning.
Försök få en vana vid att gradvis och inkrementellt förbättra saker. Ibland behövs det verkligen en stor refaktorisering eller omskrivning, men affärsvärdet av detta måste noggrant vägas mot andra prioriteringar.
Fortsätt att förbättra dig som programmerare
Läs böcker, läs blogginlägg, läs andras kod, fundera noga över design och programmeringsmetoder. Reflektera medvetet över din kod och fundera på hur du kan förbättra den.
Istället för att skylla på den tidigare programmeraren för att ha lämnat ett dåligt arv, se till att du inte blir den programmerare som skapar ett nytt arv.