Siz üçün keyfiyyətli kod nədir?

Mənim üçün keyfiyyətli kod aşağıdakı xüsusiyyətlərə malikdir:

• Oxunaqlıq: Digər inkişaf etdiricilər üçün (və altı ay sonra özüm üçün) asan başa düşüləndir.
• Dəstək: Dəyişikliklər və səhv düzəlişləri sürətli və təhlükəsiz şəkildə həyata keçirilir.
• Test edilə bilmə: Kod modullara bölünür və asanlıqla ayrılıb test edilə bilər.
• Təmizlik: Təkrarlanmadan (DRY), dəyişənlər və funksiyalar üçün aydın adlar, kod stilinə riayət.
• Effektivlik: Resursların (prosessor, yaddaş) optimal istifadəsi.
• Etibarlılıq: Mümkün səhvləri (istisnalar, null dəyərlər) nəzərə alır və düzgün idarə edir.
• Sənədləşdirmə: Lazım olduqda, aydın şərhlər və ya sənədləşdirmə daxildir.

Təkrarlamadan qaçan təmiz kod nümunəsi:

// Pis: məntiqin təkrarlanması
fun processUser(user: User) {
    if (user.isActive) {
        println("Aktiv istifadəçini emal edir ${user.name}")
        // Çox kod...
    } else {
        println("İşləmsiz istifadəçini emal edir ${user.name}")
        // Eyni çox kod...
    }
}

// Yaxşı: təkrarlanan məntiqin çıxarılması
fun processUser(user: User) {
    println("İstifadəçini emal edir ${user.name}") // Ümumi məntiq
    if (user.isActive) {
        processActiveUser(user)
    } else {
        processInactiveUser(user)
    }
    // Çox kod... // if/else-dən sonra ümumi məntiq
}

fun processActiveUser(user: User) {
    // Yalnız aktiv istifadəçilər üçün xüsusi məntiq
}

fun processInactiveUser(user: User) {
    // Yalnız inaktiv istifadəçilər üçün xüsusi məntiq
}

Oxunaqlığı və aydın adları nümayiş etdirən nümunə:

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

// Yaxşı
fun calculateSum(firstNumber: Int, secondNumber: Int): Int {
    return firstNumber + secondNumber
}