Kodningsregler
Kommentarer och kodlayout
Programkod ska läsas av människor och inte bara av datorer. För att underlätta för människan ska man skriva kommentarer dvs text som bara är till för det mänskliga ögat och ignoreras av datorn.
I Python använder man #-tecknet för att markera att resten av raden är en kommentar.
I Python är ju kodlayouten inte bara för människan utan påverkar även betydelsen av koden.
Indenteringen som används i if- och while-satser är ju ett exempel på detta.
- Strukturen på en python-fil: import-satser överst, sedan funktions-definitioner, sist funktionsanrop.
- Ingen "lös" kod mellan funktions-definitionerna, all lös kod samlas till efter funktions-definitionerna.
- Rimliga variabelnamn.
- Inga globala variabler.
- Ta bort variabler som inte används till något
- "Luftig kod", dvs tomma rader på lämpliga ställen.
- Kommentarer på ställen i koden som gör den förståelig.
- Använd funktioner och upprepa inte kod!
- Före funktionshuvudet/metodhuvudet: Kommentera kort vad funktionen/metoden gör, kommentera vad parameterna betyder och vad funktionen/metoden returnerar (om den gör det)
I dokumentet PEP 8 -- Style Guide for Python Code finns det fullständiga regelverket.
De viktigaste punkterna är:
- Indenteringen ska ske med 4 blanksteg per nivå
-
Raderna bör inte vara längre än att de ryms/syns i editorns fönster, förslagsvis 80 tecken.
Ett\sist på raden indikerar att satsen fortsätter på nästa rad. (Det går att dela upp satser på flera rader om man delar på "vettiga" ställen.) - Två blanka rader mellan funktionsdefinitioner.
- Blanktecken efter kommatecken.
- Inget blanktecken efter
(eller före). - Blanktecken kring tilldelningsoperatorerna
