Mit jelent szerinted a jó minőségű kód írása?

Tisztaság, olvashatóság, karbantarthatóság, tesztelhetőség, biztonság, teljesítmény, a szabványoknak és a projekt követelményeinek való megfelelés. A kódnak könnyen érthetőnek kell lennie más fejlesztők számára, és a jövőbeni módosításokhoz is alkalmasnak.

A jó minőségű kód fő szempontjai:

• Olvashatóság: Jelentős változónevek, függvények és osztályok használata. Helyes formázás és behúzás.
• Karbantarthatóság: Modularitás, gyenge összekapcsoltság a komponensek között. Minimális kódduplikáció (DRY - Don't Repeat Yourself).
• Tesztelhetőség: Könnyen automatikusan és kézzel tesztelhető kód. Egység- és integrációs tesztek megléte.
• Biztonság: Védelmet nyújt a sebezhetőségek ellen (XSS, SQL Injection stb.). Bemeneti adatok validálása.
• Teljesítmény: Hatékony erőforrás-használat (memória, processzor). Szűk keresztmetszetek elkerülése.
• Szabványoknak való megfelelés: A csapat vagy iparág által elfogadott kódolási szabványok betartása.
• Dokumentáció: Komplex kódhoz kommentek, API dokumentáció (ha alkalmazható).

Tiszta és olvasható kód példája:

# Egy téglalap területének kiszámítására szolgáló függvény
def calculate_rectangle_area(width, height):
    # Ellenőrzi, hogy a bemeneti adatok pozitívak-e
    if width <= 0 or height <= 0:
        raise ValueError("A szélesség és magasság pozitív számok legyenek")
    return width * height

# A függvény használata
rectangle_width = 10
rectangle_height = 5
area = calculate_rectangle_area(rectangle_width, rectangle_height)
print(f"A téglalap területe: {area}")

Kevésbé tiszta kód példája:

def calc_area(w, h): # Rövid és nem egyértelmű nevek
    if w <= 0 or h <= 0: # Típusellenőrzés nélkül
        raise ValueError("Input must be positive") # Nem informatív hibaüzenet
    return w*h

A két példa közötti különbség rámutat arra, hogy a névadás, az olvashatóság és a hibakezelés miért fontos a kód minősége szempontjából.