För att göra det lättare att hitta i koden är det bör den följa en genomtänkt koddisposition. Nedan är en vanlig disposition som används i många språk.

1. Alla import-satser placeras högst upp i filen (se också PEP8 - Imports för intern ordning)
2. Eventuella globala konstanter
3. Funktionsdefinitioner och klassdefinitioner
4. Kod utanför funktioner, t.ex. anrop till en main()-funktion och annan kod i if __name__ == "__main__": -block.

• Alla satser som består av fler än en rad ska ha en tillhörande kommentar. Dvs if-satser, loopar, funktioner och metoder. Kommentaren ska inte vara en “innantilläsning” av koden den hör till. Använd rätt notation (dvs. """ för dokumentationssträngar, # för kommentarer i löpande kod, se PEP8 och PEP257).
  • Anmärkning: Kommentarskravet reflekterar inte nödvändigtvis kommentarskrav “i verkligheten” utan finns som krav i kursen för att ni ska öva er på att skriva kommentarer som förklarar kod. I verkligheten är det viktigare att koden är “självdokumenterande” med bra namn på variabler och funktioner, och att kommentarer bara används sparsamt när det verkligen behövs.
• Funktioner och variabler ska vara döpta på ett bra sätt, dvs att de är beskrivande och reflekterar innehåll/funktion. Låt funktionsnamn vara verb och variabelnamn vara substantiv. Undvik namn på enbart en bokstav (var beredda att kunna motivera varför ni valt just det namnet). Se PEP8 - Naming Conventions för mer detaljer.

Här är icke-godkänd kod:

1
2
3
4
5
6
7
8

v = 0
q = 0
u = [19, 21, 24, 20]

# för alla element t i u, lägg till t till v
for t in u:
    v += t
q = v/len(u)

Här är en godkänd variant:

1
2
3
4
5
6
7
8

sum_age = 0
avg_age = 0
ages = [19, 21, 24, 20]

# beräkna summan av alla åldrar
for age in ages:
    sum_age += age
avg_age = sum_age/len(ages)

Minimera användningen av “hårdkodade” värden, dvs. litteraler på allehanda ställen i koden, använd istället variabler eller konstanter med förklarande namn.

Som tumregel kan ni tänka att om ni använder samma litteral på fler än ett ställe i samma syfte, eller om det är en sifferlitteral som inte är -1, 0 eller 1, så ska ni ersätta det med en variabel.

En annan anledning att byta ut ett hårdkodat värde mot en variabel är för att enklare kunna experimentera med olika värden genom att ändra variabelvärden som samlats på ett smidigt ställe i koden.Om ni tänker “Men det är så svårt att komma på vad vi ska döpa den till” så ska ni komma ihåg att det är ännu svårare för en utomstående att förstå vad syftet med värdet är.

Användning av hårdkodade siffervärden (även kallade för “magic numbers”) ses generellt sett som ett anti-mönster, dvs. ett mönster man ska undvika. Läs mer om detta på t.ex. Wikipedia.

Ej godkänd kod

kontosaldo = 2000
att_betala = 500 - (500 * 0.1)
att_betala += 240 - (240 * 0.1)
kontosaldo -= att_betala

Godkänd kod

kontosaldo = 2000
pris_godis = 500
pris_godispåse = 240
rabatt = 0.1
att_betala = pris_godis - (pris_godis * rabatt)
att_betala -= pris_godispåse - (pris_godispåse * rabatt)
kontosaldo -= att_betala

• Dela upp er kod i delfunktioner vid behov:
  • när ni stöter på kod som ni upprepar, bryt ut koden (lägg koden i en separat funktion/metod)
  • skicka nödvändig information som argument till funktionen och låt den returnera eventuellt resultat, använd inte globala variabler
  • dela även upp er kod i fler funktioner/metoder när den blir för lång

Som tumregler, försöka se till att era funktioner

• endast gör en sak
• inte är längre än 15 rader (gärna kortare) exklusive kommentarer