Sizcə, keyfiyyətli kod yazmaq nə deməkdir?

Aydınlıq, oxunaqlılıq, saxlanma, sınaqdan keçirmə, təhlükəsizlik, performans, standartlara və layihə tələblərinə uyğunluq. Kod digər proqramçılar üçün asan başa düşülən və gələcəkdə dəyişikliklər etmək üçün əlverişli olmalıdır.

Keyfiyyətli kodun əsas aspektləri:

• Oxunaqlılıq: Dəyişənlər, funksiyalar və sinflər üçün mənalı adların istifadəsi. Düzgün format və boşluqlar.
• Saxlanma: Modullarlıq, komponentlərin zəif əlaqəliliyi. Kodun minimal təkrarı (DRY - Don't Repeat Yourself).
• Sınaqdan keçirmə: Kodun avtomatik və əl ilə sınaqdan keçirilməsi asan olmalıdır. Birlik və inteqrasiya testlərinin mövcudluğu.
• Təhlükəsizlik: Zəifliklərdən qorunma (XSS, SQL Injection və s.). Giriş məlumatlarının yoxlanması.
• Performans: Resursların səmərəli istifadəsi (yaddaş, prosessor). "Darboğazlar"-ın qarşısını almaq.
• Standartlara uyğunluq: Komanda və ya sənayedə qəbul edilən kodlaşdırma standartlarına riayət etmək.
• Sənədləşdirmə: Çətin kod üçün şərhlər, API sənədləşdirməsi (əgər tətbiq olunursa).

Təmiz və oxunaqlı kod nümunəsi:

# Düzbucağın sahəsini hesablamaq üçün funksiya
def calculate_rectangle_area(width, height):
    # Giriş məlumatlarının müsbət olub-olmadığını yoxlamaq
    if width <= 0 or height <= 0:
        raise ValueError("En və hündürlük müsbət ədədlər olmalıdır")
    return width * height

# Funksiyanın istifadəsi
rectangle_width = 10
rectangle_height = 5
area = calculate_rectangle_area(rectangle_width, rectangle_height)
print(f"Düzbucağın sahəsi: {area}")

Daha az təmiz kod nümunəsi:

def calc_area(w, h): # Qısaldılmış və aydın olmayan adlar
    if w <= 0 or h <= 0: # Tip yoxlaması yoxdur
        raise ValueError("Input must be positive") # Az məlumatlı xəta mesajı
    return w*h

İki nümunə arasındakı fərq, adlandırma, oxunaqlılıq və səhv idarəetməsinin kod keyfiyyətinə təsirini göstərir.