Ką jums reiškia 'teisingas kodas'?

„Tinkamas kodas" man yra kodas, kuris atitinka šiuos kriterijus, prioriteto tvarka:

1. Funkcionalumas ir tikslumas: Kodas išsprendžia užduotį, veikia be klaidų ir atitinka reikalavimus.
2. Skaitomumas ir aiškumas: Kodas lengvai suprantamas kitiems kūrėjams (ir man ateityje). Tai pasiekiama:
   • prasmingais kintamųjų, funkcijų ir klasių pavadinimais.
   • nuoseklia stiliaus laikymusi (Python PEP 8).
   • loginių blokų skaidymu.
   • minimalia "magijos" naudojimu, jei tai nėra būtina.
3. Palaikomumas: Kodas lengvai modifikuojamas, papildomas ir tikrinamas. Tai susiję su skaitomumu, bet taip pat apima:
   • silpną komponentų susiejimą.
   • modulinius sprendimus.
   • testų aprėptį.
4. Našumas (jei būtina): Kodas efektyvus išteklių naudojimo požiūriu (laiko ir atminties), kai tai kritiška užduočiai. Anksčiau optimizacija nėra skatinama.
5. Testuojamumas: Kodas yra sukurtas taip, kad jį būtų lengva padengti automatizuotais testais.

Pavyzdys paprasto, bet "teisingo" kodo, iliustruojančio skaitomumą ir aiškumą:

# Funkcija apskaičiuoti stačiakampio plotą
def calculate_rectangle_area(width, height):
    # Patikrinimas dėl neigiamų reikšmių, nors paprastumo dėlei praleistas
    return width * height

# Funkcijos naudojimas
rectangle_width = 10
rectangle_height = 5
area = calculate_rectangle_area(rectangle_width, rectangle_height)
# print(f"Stačiakampio plotas: {area}") # Išvedimui

Mažiau "teisingo" kodo pavyzdys (mažiau skaitomas):

def calc(w, h): # Neaiškūs funkcijos ir parametrų pavadinimai
    return w * h

Galutinis rezultatas, "teisingas kodas" – tai pusiausvyra tarp veikimo, suprantamumo ir galimybės toliau tobulinti.