Kap 4.4 – Kodstandard och struktur

Mål med lektionen

När du har arbetat klart med denna lektion ska du:

• Förstå varför kodstandard är viktigt i programmering.
• Känna till vanliga konventioner för kodstruktur i Python och C#.
• Kunna skriva kod som är lätt att läsa, förstå och underhålla.
• Använda kommentarer och namngivning för att förklara syfte och funktion.

Så här lär du dig bäst

För att lära dig kodstandard behöver du jämföra bra och dåliga exempel. Läs kod från tidigare uppgifter och förbättra den enligt standard. Testa att samarbeta med en klasskamrat och se om ni kan förstå varandras kod utan att förklara muntligt. Följ riktlinjerna för ditt språk konsekvent.

Centrala begrepp

• läsbarhet – Hur lätt det är för andra att förstå din kod.
• indentering – Att koden har rätt avstånd och är tydligt strukturerad.
• namngivning – Att använda beskrivande namn på variabler, metoder och klasser.
• kommentarer – Att skriva förklaringar i koden utan att det påverkar körningen.
• DRY-principen – "Don't Repeat Yourself" – undvik upprepningar i kod.

Exempel: Python-standard

Dåligt:

def x(a):
    return a*a

Bättre:

def square(number):
    """Returnerar kvadraten av ett tal."""
    return number * number

• Funktioner och variabler skrivs i snake_case.
• Kommentarer ska förklara varför, inte vad koden gör.
• Kod bryts i lagom långa delar med tydlig logik.

Riktlinjer

• Skriv korta metoder – helst inte längre än 20 rader.
• Använd tomma rader för att dela upp logiska delar.
• Namnge allt så tydligt att man förstår koden utan kommentar.
• Kommentera komplex logik, inte självklarheter.

Sammanfattning

• Kodstandard gör att fler kan läsa, förstå och vidareutveckla din kod.
• Struktur och tydlighet gör dina program mer professionella.
• God kodstil är lika viktig som att programmet fungerar.