Att skriva och presentera rapporter - Teknisk-naturvetenskaplig ...

• Fokusera på icke­triviala delar och undvik onödiga detaljer.
• Sök en balans mellan detaljer och övergripande idéer. En
algoritmbeskrivning som är väldigt detaljerad kan vara lätt att direkt
implementera, men besvärlig att förstå och att analysera.
• Det är ofta lämpligt med en numrerad lista i flera nivåer
(indentering).
• Fokusera inte för mycket på syntaxen. Till skillnad från ett
programmeringsspråk är syntaxen för pseudokod inte helt bestämd
på förhand. Det viktiga är att vara konsekvent och tydlig.
• Om algoritmen är stor eller komplex är det ofta en bra idé att
försöka dela in beskrivningen av den i mindre delar för ökad
läsbarhet.
• Använd inte semikolon och andra onödiga tecken som vanligtvis
används i t.ex. Java och C. Läsaren är en människa och inte en
kompilator!
• Det är ofta bra att ange tydligt vad algoritmen tar som indata och ger
som utdata.
En algoritmbeskrivning för Euklides algoritm kan t.ex. se ut som i exemplet
nedan (Algoritm 1). Observera att vi inte behöver ange att a och b är heltal då
detta är uppenbart från kontexten. Om man använder LaTeX kan paketet
algorithmicx användas.
Algoritm 1 Euklides algoritm: Största gemensamma delaren av a och b
1 procedure EUCLID(a,b)
2 r ← a mod b
3 while r ≠ 0 do ▹ Om r = 0 har vi svaret
4 a ← b
5 b ← r
6 r ← a mod b
7 end while
8 return b ▹ SGD är b
9 end procedure
29