Τι θεωρείτε ποιοτικό κώδικα;

Για μένα, ο ποιοτικός κώδικας διαθέτει τα εξής χαρακτηριστικά:

• Αναγνωσιμότητα: Είναι εύκολο να κατανοηθεί από άλλους προγραμματιστές (και από τον ίδιο μετά από έξι μήνες).
• Διαχειρισιμότητα: Οι αλλαγές και οι διορθώσεις σφαλμάτων πραγματοποιούνται γρήγορα και με ασφάλεια.
• Δοκιμαστικότητα: Ο κώδικας είναι χωρισμένος σε modules που είναι εύκολο να απομονωθούν και να δοκιμαστούν.
• Καθαριότητα: Απουσία διπλοτύπων (DRY), σαφή ονόματα μεταβλητών και συναρτήσεων, τήρηση του στυλ κώδικα.
• Αποδοτικότητα: Βέλτιστη χρήση πόρων (επεξεργαστής, μνήμη) για την εργασία.
• Αξιοπιστία: Λαμβάνει υπόψη πιθανά σφάλματα (εξαιρέσεις, null τιμές) και τα χειρίζεται σωστά.
• Τεκμηρίωση: Όταν χρειάζεται, περιέχει σαφείς σχολιασμούς ή τεκμηρίωση.

Παράδειγμα καθαρού κώδικα που αποφεύγει την επανάληψη:

// Κακό: επανάληψη λογικής
fun processUser(user: User) {
    if (user.isActive) {
        println("Επεξεργασία ενεργού χρήστη ${user.name}")
        // Πολλός κώδικας...
    } else {
        println("Επεξεργασία ανενεργού χρήστη ${user.name}")
        // Ο ίδιος πολύς κώδικας...
    }
}

// Καλό: απομόνωση επαναλαμβανόμενης λογικής
fun processUser(user: User) {
    println("Επεξεργασία χρήστη ${user.name}") // Κοινή λογική
    if (user.isActive) {
        processActiveUser(user)
    } else {
        processInactiveUser(user)
    }
    // Πολλός κώδικας... // Κοινή λογική μετά το if/else
}

fun processActiveUser(user: User) {
    // Μόνο συγκεκριμένη λογική για ενεργούς
}

fun processInactiveUser(user: User) {
    // Μόνο συγκεκριμένη λογική για ανενεργούς
}

Παράδειγμα που δείχνει αναγνωσιμότητα και σαφή ονόματα:

// Κακό
fun calc(a: Int, b: Int): Int {
    return a + b
}

// Καλό
fun calculateSum(firstNumber: Int, secondNumber: Int): Int {
    return firstNumber + secondNumber
}