Mis on teie jaoks kvaliteetne kood?

Kvaliteetne kood minu jaoks omab järgmisi omadusi:

• Lugemise lihtsus: Seda on lihtne mõista teiste arendajate jaoks (ja enda jaoks kuue kuu pärast).
• Hooldatavus: Muudatused ja veaparandused toimuvad kiiresti ja turvaliselt.
• Testitavus: Kood on jagatud mooduliteks, mida on lihtne isoleerida ja testida.
• Puhas: Ilma dubleerimiseta (DRY), selged muutujate ja funktsioonide nimed, järgides koodistiili.
• Tõhusus: Ressursside (protsessor, mälu) optimaalne kasutamine ülesande jaoks.
• Usaldusväärsus: Arvestab võimalikke vigu (Erandid, nullväärtused) ning käsitleb neid õigesti.
• Dokumentatsioon: Vajadusel sisaldab selgeid kommentaare või dokumentatsiooni.

Näide puhtast koodist, mis väldib dubleerimist:

// Halb: dubleeritud loogika
fun processUser(user: User) {
    if (user.isActive) {
        println("Processing active user ${user.name}")
        // Palju koodi...
    } else {
        println("Processing inactive user ${user.name}")
        // Sama palju koodi...
    }
}

// Hea: korduva loogika eraldamine
fun processUser(user: User) {
    println("Processing user ${user.name}") // Ühine loogika
    if (user.isActive) {
        processActiveUser(user)
    } else {
        processInactiveUser(user)
    }
    // Palju koodi... // Ühine loogika pärast if/else
}

fun processActiveUser(user: User) {
    // Ainult spetsiifiline loogika aktiivsete jaoks
}

fun processInactiveUser(user: User) {
    // Ainult spetsiifiline loogika mitteaktiivsete jaoks
}

Näide, mis näitab lugemise lihtsust ja selgeid nimesid:

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

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