Vikten av att skriva snygg kod
Förord
Att skriva snygg kod kan tyckas oviktigt. Det tar bara längre tid och jag vet ju vad jag skrivit, eller?
Vad innebär ”snygg kod”?
Snygg kod innebär för min egen del lättläslig, strukturerad kod. Oavsett om du skriver kod för webben eller spel/program så är vikten av att koden är strukturerad oundviklig. Det kan tyckas onödigt i små program, eller program som ingen annan än du någonsin kommer att läsa. Men faktum är att du inte lär komma ihåg hur du tänkte för ett år sedan när koden skrevs, och du har ingen aning om vad alla förkortningar betyder. Vad gör du nu?
Att skapa en vana
När du börjar programmera är det viktigt att genast skapa en god vana. Ta den extra tiden att strukturera din kod medan den skrivs (inte efteråt) och kommentera den där det kan behövas. De här extra sekunderna det tar att slänga in några indrag och kommentarer sparar du in när det är dags att felsöka en kod som inte fungerar.
Att kommentera din kod
Kommentarer kan vara väldigt viktiga. Framförallt om du arbetar/ska arbeta tillsammans med andra programmerare i något projekt. De måste då kunna se hur du har tänkt och förstå vad det är du har knåpat ihop.
Undvik krångliga förkortningar
Visst kan det vara frestande att förkorta exempelvis namnen i dina variabler ända tills ingen har någon aning om vad förkortningen står för, endast för att det går fortare att skriva mfvfmt än MinFörstaVariabelFörMatteTal. Men sådana förkortningar lär glömmas bort tio minuter efter att de skrivits ner. Återigen, ta den extra tiden så att du och andra förstår vad du har skrivit.
Vikten av snygg kod vid felsökning
Nu kommer vi tillbaka till felsökning. Jag ska dra ett exempel med hjälp av Pascal-kod.
program HelloWorld;
uses Crt;
{$APPTYPE Console}
begin
Write(’Hello World’);
ReadLn;
end.
program SvarLastHelloWorld;uses Crt;{$APPTYPE Console}beginWrite(’Hello World’);ReadLn;end.
Programmen är detsamma, men kod 2 är lite jobbigare att läsa än kod 1. Det här var ändå ett väldigt litet program. Allt det gör är att skriva ut texten Hello World. Tänk dig då ett större program i samma typ av struktur, om det nu kan kallas struktur.
Att läsa/ändra i sin gamla kod
Det kommer med största säkerhet ett tillfälle i ditt programmerarliv då du vill gå tillbaka i ett äldre program och se efter hur du löste ett problem, eller du kanske vill ändra lite i koden och bygga om eller bygga ut ditt program med nya bättre, eller mer intressanta funktioner. Då gäller det att koden går att läsa, så att du vet hur du ska hitta koden du vill ändra i, eller platsen där du ska börja bygga ut programmet.
Att skriva för andra
Här kommer ett litet men väl fungerande tips som förhoppningsvis kan hjälpa dig. Det skulle kunna hjälpa mig om jag inte redan var en obotlig struktur-perfektionist (om nu ett sådant ord existerar) :)Tipset går ut på att du ska skriva din kod som om du skrev den åt någon annan som behövde lite hjälp. På det viset tvingas du skriva strukturerat med kommentarer på sina rätta platser.
Lycka till!
Pelle Johansson
Se http://www.derigomedia.com/hack/arkiv/hack20060426.html