Kas jums ir kvalitatīvs kods?

Augstas kvalitātes kods man raksturo šādas īpašības:

• Lasāmība: To ir viegli saprast citiem izstrādātājiem (un sev pēc pusgada).
• Atbalstāmība: Izmaiņas un kļūdu labošana notiek ātri un droši.
• Testējamība: Kods ir sadalīts moduļos, kurus viegli izolēt un testēt.
• Tīrība: Bez dublēšanās (DRY), skaidri nosaukti mainīgo un funkciju nosaukumi, ievērots koda stils.
• Efektivitāte: Optimāla resursu (procesora, atmiņas) izmantošana uzdevumam.
• Uzticamība: Ņem vērā iespējamās kļūdas (izņēmumi, null vērtības) un pareizi tās apstrādā.
• Dokumentācija: Vajadzības gadījumā satur skaidrus komentārus vai dokumentāciju.

Piemērs tīram kodam, kas izvairās no dublēšanās:

// Slikti: dublējoša loģika
fun processUser(user: User) {
    if (user.isActive) {
        println("Processing active user ${user.name}")
        // Daudz koda...
    } else {
        println("Processing inactive user ${user.name}")
        // Tas pats daudz koda...
    }
}

// Labs: atkārtojošās loģikas izdalīšana
fun processUser(user: User) {
    println("Processing user ${user.name}") // Kopēja loģika
    if (user.isActive) {
        processActiveUser(user)
    } else {
        processInactiveUser(user)
    }
    // Daudz koda... // Kopēja loģika pēc if/else
}

fun processActiveUser(user: User) {
    // Tikai specifiska loģika aktīviem
}

fun processInactiveUser(user: User) {
    // Tikai specifiska loģika neaktīviem
}

Vēl viens piemērs, kas demonstrē lasāmību un skaidrus nosaukumus:

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

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