En fråga om stil

Programkod måste ”dokumenteras” på något rimligt sätt, så att man själv och andra vet vad programmet gör, hur man använder det och hittar i koden, så att man kan rätta fel och göra tilläg och anpassningar.

På företag finns ofta omfattande regler för vad som ska skrivas och ritas innan man ens sätter sig och kodar och dessutom massor som ska skrivas under tiden och efteråt.

Vi kan göra det väsentligt enklare, men gör man det för enkelt för sig, så kommer man att upptäcka att man har massor av obegriplig kod som man inte har någon aning om vad den gör och hur.

Vettiga variabelnamn

Välj vettiga och målande variabelnamn, så blir koden lättare att läsa och förstå, både för dig själv och för andra. Namn som area, username och medelvarde är bättre och mer begripliga än a, u och m. Ett undantag kan vara räknare i loopar, där man ofta använder i och j. Jag brukar också göra undantag för vedertagna variabler och konstanter som används i de formler som utgör grunden för programmet

Även om ingen annan kommer att läsa din kod kan du själv bli mäkta förvirrad av variabelnamn som az, a7, c och x när du kommer tillbaka till ett program som du skrev för några månader sedan.

Kommentera
Skriv vettiga kommentarer i koden. Kommentarer börjar med ”brädgård”, #. Ett minimum är att skriva vad programmet heter, vad det gör och vem som har skrivit det. Gör du något extra ”smart” bör du definitivt förklara vad du gör eller hänvisa till någonting som förklarar den där speciella formeln eller beräkningssättet.

Screenshot from 2013-04-18 17:50:41

Kommentarer färgas blåa i Emacs.

Man kan faktiskt också skriva för mycket kommentarer också, så att de skymmer själva koden och gör den mer svårläst och svåröverskådlig. Lagom är bäst. Titta på många andras kod och bilda dig en egen uppfattning om vad som är lagom.

En och annan nybörjare glömmer också bort att kommentarerna inte gör någonting, det är koden mellan kommentarerna som gör jobbet! Att du skriver #Beräkna medelvärde i en
kommentar blir bara en tom besvärjelse om du inte därunder skriver en kodsnutt som verkligen räknar ut medelvärdet.

Dela upp

Dela upp koden i avsnitt som gör avgränsade delar. Det blir lite lättare senare i kursen, då du får lära dig att arbeta med något som heter ”funktioner”, men redan nu kan du göra det genom att kommentera var en ny deluppgift påbörjas. Många program har en del som handlar om inmatning, en del som gör själva beräkningen eller bearbetningen och en del som handlar om utmatning av resultatet. Jag kan inte komma på något icketrivialt program som jag har skrivit, som inte passar in i den mallen.

+-----------+     +-------------+     +-----------+
| Inmatning | --> | Bearbetning | --> | Utmatning |
+-----------+     +-------------+     +-----------+