Sobes.tech
Junior

Mit jelent szerinted, minőségi kódot írni?

sobes.tech MI

Válasz az MI-től

Tisztaság, olvashatóság, karbantarthatóság, skálázhatóság és a követelményeknek való megfelelés.

Főbb szempontok:

  • Tisztaság és olvashatóság:

    • Érthető, leíró neveket használni változók, függvények és osztályok számára.
    • Egységes kódolási stílus követése.
    • Megfelelő kódformázás (behúzások, szóközök).
    • Kódduplikációk eltávolítása (DRY - Don't Repeat Yourself).
    • Egyértelmű kommentek a nem nyilvánvaló kódrészekhez.
  • Karbantarthatóság:

    • Könnyű módosítás és hibajavítás.
    • Modularitás: funkciók felosztása kicsi, független blokkokra.
    • Alacsony kötöttség és magas kohézió.
    • Automatizált tesztek (egység, integráció, végpontok közötti).
  • Skálázhatóság:

    • A rendszer képes kezelni növekvő adatmennyiséget vagy terhelést anélkül, hogy jelentősen romlana a teljesítmény.
    • Hatékony erőforrás-használat.
  • A követelményeknek való megfelelés:

    • A kód helyesen valósítja meg az üzleti logikát és a funkcionális követelményeket.
    • Kritikus hibák és sebezhetőségek hiánya.

Példa egy minőségi teszt szerkezetére Pythonban:

# filename: test_user_creation.py

import pytest
from my_application.models import User
from my_application.services import create_user

def test_user_creation_successful():
    # Sikeres felhasználó létrehozásának teszt esete
    username = "test_user"
    email = "test@example.com"

    # Művelet: Felhasználó létrehozása
    new_user = create_user(username, email)

    # Ellenőrzés 1: Ellenőrizze, hogy a felhasználói objektum létrejött
    assert isinstance(new_user, User)

    # Ellenőrzés 2: Ellenőrizze, hogy a felhasználónév helyes
    assert new_user.username == username

    # Ellenőrzés 3: Ellenőrizze, hogy az email helyes
    assert new_user.email == email

def test_user_creation_duplicate_username():
    # Sikertelen felhasználó létrehozás duplikált felhasználónévvel
    username = "existing_user"
    email = "another@example.com"

    # Előfeltétel: Létrehoz egy meglévő felhasználót
    create_user(username, "existing@example.com")

    # Művelet és ellenőrzés: Próbáljon meg felhasználót létrehozni duplikált névvel, és várjon kivételt
    with pytest.raises(ValueError, match="Username already exists"):
        create_user(username, email)

# ... más tesztesetek ...