Apakah Kod Bersih?

Hai dev,
Apabila pembangun bercakap tentang "kod bersih," mereka biasanya merujuk kepada kod yang mudah dibaca, difahami dan diselenggara. Kod bersih bukan sahaja untuk menjadikan kod anda kelihatan menarik—ia juga mengenai menulis kod yang boleh diambil, difahami dan diubah suai oleh sesiapa sahaja dalam pasukan anda tanpa perlu mengharungi komen yang tidak berkesudahan atau logik yang mengelirukan. Menulis kod bersih adalah mengenai ketukangan dan mengamalkan pemikiran yang mementingkan kesederhanaan, kejelasan dan tujuan.

Dalam siaran ini, kami akan meneroka prinsip utama kod bersih, sebab ia penting dan memberikan contoh dalam Python untuk menunjukkan cara idea ini boleh digunakan dalam amalan.

---

Mengapa Kod Bersih Penting

1. Kebolehbacaan: Kod lebih kerap dibaca daripada ditulis. Kod bersih memastikan ia boleh dibaca dan difahami dengan cepat oleh orang lain (dan oleh anda pada masa hadapan).
2. Kebolehselenggaraan: Kod bersih lebih mudah untuk diubah suai, diperbaiki dan dilanjutkan tanpa memperkenalkan pepijat.
3. Skalabiliti: Kod modular yang bersih lebih mudah untuk skala dan disesuaikan dengan keperluan baharu.
4. Hutang Teknikal Mengurangkan: Kod yang tidak kemas boleh membawa kepada pepijat dan setiap pembaikan memperkenalkan lebih kerumitan. Kod bersih mengelakkan lingkaran ini dengan mengekalkan kesederhanaan.

Faedahnya jelas, tetapi mencapai kod bersih adalah satu disiplin. Mari lihat prinsip asas.

---

Prinsip Utama Kod Bersih

1. Nama Bermakna

Nama harus menyampaikan niat. Pembolehubah, fungsi dan nama kelas hendaklah menerangkan tujuannya dengan jelas.

Contoh:

# Bad
def cal(x, y):
    return x * y

# Good
def calculate_area(width, height):
    return width * height

Dalam contoh "buruk", tidak jelas apa yang diwakili oleh kal, x dan y. Dalam contoh "baik", hitung_luas, lebar dan tinggi menyampaikan tujuan dan jadikan kod itu sendiri.

---

2. Prinsip Tanggungjawab Tunggal (SRP)

Setiap fungsi atau kelas harus mempunyai satu tanggungjawab atau tujuan. Ini mengurangkan kerumitan dan menjadikan kod lebih mudah difahami dan diselenggara.

Contoh:

# Bad
class Order:
    def calculate_total(self, items):
        # Logic for calculating total
        pass

    def send_order_confirmation_email(self):
        # Logic for sending an email
        pass

# Good
class Order:
    def calculate_total(self, items):
        # Logic for calculating total
        pass

class OrderConfirmationEmail:
    def send(self):
        # Logic for sending an email
        pass

Dalam contoh "baik", Pesanan dan E-mel Pengesahan Pesanan bertanggungjawab untuk pelbagai aspek aplikasi, mengikut SRP.

---

3. Elakkan Nombor Ajaib dan Rentetan

Gunakan pemalar atau pembolehubah untuk sebarang nombor atau rentetan "ajaib" untuk menjadikan kod anda lebih jelas dan mudah diubah suai.

Contoh:

# Bad
if user_age > 18:
    # Perform some action for adults

# Good
MINIMUM_AGE = 18
if user_age > MINIMUM_AGE:
    # Perform some action for adults

---

4. Pastikan Fungsi Kecil dan Fokus

Fungsi harus melakukan satu perkara dan melakukannya dengan baik. Elakkan mempunyai fungsi yang panjang atau melakukan pelbagai tugas.

Contoh:

# Bad
def process_order(order):
    # Validate order
    # Calculate total
    # Send confirmation email
    pass

# Good
def validate_order(order):
    pass

def calculate_order_total(order):
    pass

def send_order_confirmation(order):
    pass

Setiap fungsi dalam contoh "baik" melakukan satu tugas khusus, menjadikan kod lebih modular dan boleh digunakan semula.

---

5. Gunakan Komen dengan Bijak

Komen hendaklah menerangkan "mengapa", bukan "apa." Kod sepatutnya jelas sendiri; gunakan ulasan dengan berhati-hati dan untuk konteks hanya apabila perlu.

Contoh:

# Bad
def cal(x, y):
    return x * y

# Good
def calculate_area(width, height):
    return width * height

Dalam contoh "buruk", ulasan adalah berlebihan. Dalam contoh "baik", ulasan memberikan konteks tambahan, menerangkan sebab kami menggunakan diskaun.

---

6. Pemformatan Konsisten

Pemformatan yang konsisten, seperti lekukan dan pemisah baris, meningkatkan kebolehbacaan. Ikuti panduan gaya standard seperti PEP 8 untuk Python, atau tentukan konvensyen pengekodan pasukan anda.

Contoh:

# Bad
class Order:
    def calculate_total(self, items):
        # Logic for calculating total
        pass

    def send_order_confirmation_email(self):
        # Logic for sending an email
        pass

# Good
class Order:
    def calculate_total(self, items):
        # Logic for calculating total
        pass

class OrderConfirmationEmail:
    def send(self):
        # Logic for sending an email
        pass

---

7. Pengendalian Ralat

Kendalikan ralat dengan baik. Kod harus menjangka kemungkinan ralat, dengan mesej ralat yang jelas dan pilihan pemulihan.

Contoh:

# Bad
if user_age > 18:
    # Perform some action for adults

# Good
MINIMUM_AGE = 18
if user_age > MINIMUM_AGE:
    # Perform some action for adults

Contoh "baik" memastikan ralat dikendalikan dan sumber ditutup dengan betul.

---

Minda Disebalik Kod Bersih

Kod bersih memerlukan pemikiran yang mengutamakan kesederhanaan, kejelasan dan empati untuk pembangun lain yang akan membaca dan mengekalkan kod tersebut. Pemikiran ini menghargai amalan yang memastikan kod ringkas tetapi bermaklumat, mengurangkan kerumitan yang tidak perlu dan menjadikan pangkalan kod lebih dipercayai dan menyeronokkan untuk digunakan.

---

Membungkus

Menulis kod bersih ialah proses pembelajaran yang berterusan dan memerlukan usaha dan disiplin. Ingat:

• Namakan perkara dengan jelas.
• Pastikan fungsi kecil.
• Patuhi Prinsip Tanggungjawab Tunggal.
• Kendalikan ralat dengan baik.

Kod bersih mungkin kelihatan seperti usaha tambahan, tetapi hasil dalam kebolehselenggaraan, kerjasama dan kalis masa hadapan kerja anda adalah tidak ternilai. Hayati prinsip ini dan anda akan terus membina perisian yang bukan sahaja berfungsi tetapi menyeronokkan untuk digunakan.

Mari kita pastikan kod kita bersih dan projek kita boleh skala!

Atas ialah kandungan terperinci Apakah Kod Bersih?. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!