Kod Kotor: Peraturan Mudah untuk Mengelaknya

Setiap pembangun pernah menghadapinya: kod kotor—jenis kod yang kelihatan seperti ditulis dengan tergesa-gesa, ditaburi dengan nombor ajaib, blok pendua dan nama pembolehubah samar. Ia berfungsi... hampir tidak. Tetapi mengekalkannya? Itu mimpi ngeri.

Jika anda pernah merungut dalam nafas anda semasa memfaktorkan semula kod orang lain (atau pun anda sendiri), artikel ini adalah untuk anda. Berikut ialah beberapa peraturan mudah untuk memastikan kod anda bersih, boleh dibaca dan kalis masa hadapan.

Apakah Kod Kotor?
Kod kotor ialah kod yang:

• Sukar untuk dibaca atau difahami.
• Kurang struktur dan konsistensi.
• Sukar untuk diubah suai atau nyahpepijat tanpa melanggar sesuatu yang lain.

Ini selalunya berlaku apabila pembangun:

1. Bekerja di bawah tarikh akhir yang ketat.
2. Langkau ulasan kod.
3. Jangan ikut amalan atau piawaian terbaik.

Mengapa Kod Kotor Menjadi Masalah?

• Sukar untuk Nyahpepijat: Membetulkan satu pepijat boleh memperkenalkan lima pepijat yang lain.
• Mahal untuk Diselenggara: Kod yang ditulis dengan buruk mengambil masa lebih lama untuk diperbaiki.
• Kekeliruan Pasukan: Pembangun baharu menghabiskan masa tambahan hanya cuba memahami perkara yang berlaku. Kod kotor mungkin menyelesaikan tugas hari ini, tetapi ia adalah bom masa untuk pasukan anda dan diri masa depan anda.

Peraturan Mudah untuk Mengelak Kod Kotor

1. Ikut Prinsip Tanggungjawab Tunggal (SRP)
Setiap fungsi, kaedah atau kelas harus melakukan hanya satu perkara. Jika anda mendapati diri anda menulis kaedah dengan terlalu banyak tanggungjawab, pecahkannya kepada unit yang lebih kecil.

❌ Contoh Buruk:

def process_user_data(user):
    user['age'] = user['age'] + 1  
    db.save(user)  
    print(f"User {user['name']} updated")  

✅ Contoh Baik:

def update_user_age(user):
    user['age'] += 1  

def save_user_to_db(user):
    db.save(user)  

def log_user_update(user):
    print(f"User {user['name']} updated")  

Setiap fungsi kini mempunyai satu tugas yang jelas, menjadikan kod lebih mudah untuk diuji dan diubah suai.

2. Elakkan Nombor Ajaib dan Rentetan
Nilai berkod keras (“nombor ajaib”) menjadikan kod tidak boleh dibaca dan sukar untuk dikekalkan. Gunakan pemalar sebaliknya.

❌ Contoh Buruk:

if (statusCode === 404) {  
    console.log("Not Found");  
}

✅ Contoh Baik:

const NOT_FOUND = 404;

if (statusCode === NOT_FOUND) {  
    console.log("Not Found");  
}

NOTE_FOUND yang berterusan adalah jelas, menjadikan kod anda lebih mudah dibaca.

3. Tulis Pembolehubah Deskriptif dan Nama Fungsi
Nama pembolehubah anda harus mencerminkan perkara yang diwakilinya. Elakkan singkatan dan nama samar.

❌ Contoh Buruk:

int a = 5;  
String s = "John";  

✅ Contoh Baik:

int userAge = 5;  
String userName = "John";  

Perkara yang sama berlaku untuk fungsi. Elakkan nama yang tidak jelas seperti doStuff() atau process(). Jadi khusus.

4. KERING (Jangan Ulangi Sendiri)
Jika anda menyalin dan menampal kod, anda salah melakukannya. Kod pendua menjadikan pembetulan pepijat menjadi mimpi ngeri. Logik berulang abstrak ke dalam fungsi atau kelas.

❌ Contoh Buruk:

print("Welcome, John")  
print("Welcome, Mary")  

✅ Contoh Baik:

def process_user_data(user):
    user['age'] = user['age'] + 1  
    db.save(user)  
    print(f"User {user['name']} updated")  

5. Pastikan Fungsi Anda Singkat
Jika fungsi anda lebih panjang daripada 20-30 baris, ia melakukan terlalu banyak. Pecahkan kepada fungsi yang lebih kecil dan boleh diguna semula.

Fungsi yang panjang menjadikannya lebih sukar untuk memahami dan menguji tingkah laku tertentu.

6. Gunakan Komen dengan Berhemat
Tulis kod yang menerangkan dirinya sendiri. Gunakan komen hanya apabila perlu untuk menjelaskan logik yang kompleks. Elakkan komen yang menyatakan perkara yang jelas.

❌ Contoh Buruk:

def update_user_age(user):
    user['age'] += 1  

def save_user_to_db(user):
    db.save(user)  

def log_user_update(user):
    print(f"User {user['name']} updated")  

✅ Contoh Baik:
Jika kod anda jelas, tiada ulasan diperlukan:

if (statusCode === 404) {  
    console.log("Not Found");  
}

Gunakan ulasan untuk perkara seperti menjelaskan sebab keputusan tertentu dibuat, bukan perkara yang dilakukan oleh kod tersebut.

7. Format dan Susun Kod Anda

• Ikuti panduan gaya pengekodan yang konsisten (cth., PEP8 untuk Python, ESLint untuk JavaScript).
• Gunakan lekukan yang betul.
• Kod berkaitan kumpulan bersama-sama. Pemformatan yang baik menjadikan kod bersih dan boleh dibaca tanpa sebarang usaha tambahan.

Pemikiran Pembangun: Tulis Kod untuk Manusia
Kod bukan sahaja ditulis untuk mesin; ia juga ditulis untuk manusia—rakan sepasukan anda, penyelenggara masa depan, atau anda sendiri enam bulan ke hadapan. Apabila anda menulis kod bersih:

• Anda mengurangkan beban mental untuk orang lain.
• Anda memudahkan untuk nyahpepijat, melanjutkan dan menambah baik.
• Anda kelihatan seperti pembangun profesional yang mementingkan kualiti.

Pemikiran Akhir
Mengelakkan kod kotor tidak sukar—ia hanya memerlukan disiplin. Ikut peraturan mudah ini:

1. Berpegang pada Prinsip Tanggungjawab Tunggal.
2. Elakkan nombor ajaib.
3. Gunakan nama yang jelas dan deskriptif.
4. KERINGKAN kod berulang.
5. Pastikan fungsi pendek.
6. Gunakan komen dengan bijak.
7. Formatkan kod anda secara konsisten.

Kod bersih bukan tentang kesempurnaan; ia mengenai menjadikan kerja anda boleh diselenggara dan difahami. Diri masa depan anda—dan pasukan anda—akan berterima kasih kepada anda.

Sekarang pergi dan faktorkan semula kod yang tidak kemas yang anda abaikan itu! ?

Atas ialah kandungan terperinci Kod Kotor: Peraturan Mudah untuk Mengelaknya. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!