Mit tekintesz jó minőségű kódnak?

Számomra a jó minőségű kód a következő jellemzőkkel rendelkezik:

• Átláthatóság: Könnyen érthető más fejlesztők számára (és saját magam számára fél év múlva).
• Karbantarthatóság: A változtatások és hibajavítások gyorsan és biztonságosan végrehajthatók.
• Tesztelhetőség: A kód modulokra van bontva, amelyek könnyen izolálhatók és tesztelhetők.
• Tiszta kód: Nincs duplikáció (DRY), világos változó- és függvénynevek, a kódstílus betartása.
• Hatékonyság: Az erőforrások (processzor, memória) optimális kihasználása a feladathoz.
• Megbízhatóság: Figyelembe veszi a lehetséges hibákat (kivételek, null értékek) és helyesen kezeli azokat.
• Dokumentáció: Szükség esetén világos kommentárokat vagy dokumentációt tartalmaz.

Példa tiszta kódra, amely elkerüli a duplikációt:

// Rossz: logika duplikáció
fun processUser(user: User) {
    if (user.isActive) {
        println("Aktív felhasználó feldolgozása ${user.name}")
        // Sok kód...
    } else {
        println("Inaktív felhasználó feldolgozása ${user.name}")
        // Ugyanaz sok kód...
    }
}

// Jó: ismétlődő logika kivonása
fun processUser(user: User) {
    println("Felhasználó feldolgozása ${user.name}") // Általános logika
    if (user.isActive) {
        processActiveUser(user)
    } else {
        processInactiveUser(user)
    }
    // Sok kód... // Általános logika az if/else után
}

fun processActiveUser(user: User) {
    // Csak az aktív felhasználókra jellemző logika
}

fun processInactiveUser(user: User) {
    // Csak az inaktív felhasználókra jellemző logika
}

Példa, ami bemutatja az olvashatóságot és a világos neveket:

// Rossz
fun calc(a: Int, b: Int): Int {
    return a + b
}

// Jó
fun calculateSum(firstNumber: Int, secondNumber: Int): Int {
    return firstNumber + secondNumber
}