Bagaimana untuk menyelesaikan ralat kebolehbacaan kod yang lemah dalam kod Python?

Bahasa Python secara amnya dianggap sebagai alat yang mudah dipelajari dan mudah untuk kod. Walaupun bahasa Python ringkas dan jelas, tabiat pengekodan yang buruk boleh menyebabkan kebolehbacaan kod berkurangan. Tabiat pengekodan yang buruk juga boleh menjejaskan kebolehselenggaraan dan kebolehskalaan kod anda. Dalam artikel ini, kami akan berkongsi beberapa petua untuk meningkatkan kebolehbacaan kod Python dan mencegah tabiat buruk dalam kod.

1. Konvensyen Penamaan

Peraturan penamaan adalah asas untuk kebolehbacaan kod Python. Sama ada ia pembolehubah, fungsi atau kelas, nama itu hendaklah deskriptif dan harus disimpan dengan mudah. Elakkan menggunakan singkatan atau nama yang tidak perlu dengan singkatan yang tidak jelas. Nama pembolehubah hendaklah bermula dengan huruf kecil, manakala nama kelas hendaklah bermula dengan huruf besar. Sebagai contoh, beberapa contoh disenaraikan di bawah:

Contoh yang baik:

class UserProfile:
    def __init__(self, username, email):
        self.username = username
        self.email = email

email = "user@gmail.com"
user_profile = UserProfile("user", email)

Demo buruk:

class up:
    def __init__(self, un, e):
        self.username = un
        self.eml = e

e = "user@gmail.com"
up = up("user", e)

Walaupun yang terakhir berfungsi dengan baik, ia menjadikan kod itu sangat sukar dibaca dan diselenggara.

2. Komen

Komen ialah satu lagi komponen utama kebolehbacaan. Komen boleh meningkatkan kebolehbacaan kod, terutamanya apabila menerangkan bahagian tertentu kod atau menerangkan idea. Walau bagaimanapun, penggunaan komen yang berlebihan boleh menjadikan kod itu rumit dan sukar dibaca. Oleh itu, komen yang tidak perlu harus dielakkan dan bahagian penting harus diulas sebaliknya.

Apabila menyediakan ulasan, sebaiknya gunakan format dan gaya standard. Sebagai contoh, pembangun Python sering menggunakan petikan tiga kali ganda untuk mencipta docstrings yang merupakan sebahagian daripada modul, kelas dan kaedah dalam perpustakaan standard. Berikut ialah contoh:

class Rectangle:
    """一个代表矩形的类。

        参数:
        width (int): 矩形的宽度。
        length (int): 矩形的长度。
    """
    def __init__(self, width, length):
        self.width = width
        self.length = length

    def area(self):
        """"计算矩形的面积。"""
        return self.width * self.length

Pada ketika ini, menggunakan fungsi help() kita boleh mengakses dokumentasi kelas segi empat tepat:

>>> r = Rectangle(3,4)
>>> help(Rectangle)

Output:

Help on class Rectangle in module __main__:

class Rectangle(builtins.object)
 |  Rectangle(width, length)
 |  
 |  一个代表矩形的类。
 |  
 |  参数:
 |  width (int):矩形的宽度。
 |  length (int):矩形的长度。
 |  
 |  Methods defined here:
 |  
 |  __init__(self, width, length)
 |      Initialize self.  See help(type(self)) for accurate signature.
 |  
 |  area(self)
 |  计算矩形的面积。
 |  
 |  ----------------------------------------------------------------------
 |  Data descriptors defined here:
 |  
 |  __dict__
 |      dictionary for instance variables (if defined)
 |  
 |  __weakref__
 |      list of weak references to the object (if defined)

3. Fungsi panjang

Fungsi harus disimpan pendek. Jika terdapat terlalu banyak baris kod, ini boleh menyebabkan fungsi menjadi sukar dibaca dan difahami. Pada masa yang sama, fungsi yang lebih pendek dan fokus lebih mudah untuk dikekalkan dan diuji. Dari perspektif kebolehbacaan, tidak boleh ada lebih daripada satu skrin kod. Jika kod fungsi melebihi lima puluh baris, anda harus mempertimbangkan untuk membahagikannya kepada berbilang fungsi.

4. Bahagian Modul

Apabila membangunkan projek besar, asas kod biasanya akan merangkumi berbilang fail, jadi adalah perlu untuk membahagikan logik kod kepada modul yang boleh diselenggara dan boleh diperluaskan.

Modul hendaklah disimpan sesingkat dan fokus yang mungkin dan direka bentuk untuk menyelesaikan tugas tertentu. Tambahan pula, mereka harus mempunyai antara muka yang mudah untuk penggunaan yang lebih baik. Akhir sekali, nama modul harus sepadan dengan fungsinya.

5. Ruang yang dipetik

Dalam kod Python, Python memerlukan penambahan aksara ruang yang dipersetujui antara bahagian berlainan kod untuk meningkatkan kebolehbacaan. Contohnya, tambahkan ruang selepas koma (,) dan bertindih (:) untuk memudahkan kod dibaca. Pada masa yang sama, anda harus mengelak daripada menambah terlalu banyak ruang dalam kod untuk mengelakkan pemformatan yang berlebihan dan menjejaskan kebolehbacaan.

6. Susun kod anda

Menyusun kod anda dengan banyak boleh menjimatkan struktur kod yang baik pada masa hadapan. Dalam aplikasi Python, anda boleh menggunakan modul dan pakej untuk menyusun kod. Ia perlu menggunakan enkapsulasi kelas dan fungsi.

Pakej boleh digunakan untuk mengumpulkan modul dan subpakej yang berkaitan bersama-sama. Sebagai contoh, dalam pakej yang dipanggil mesej, anda boleh memasukkan modul yang dipanggil sms.py, yang boleh mengandungi fungsi untuk menghantar dan menerima mesej teks. mesej juga boleh mengandungi subpakej yang dipanggil e-mel, yang mengandungi modul lain yang berkaitan untuk mengendalikan e-mel.

messages/
    __init__.py
    sms.py
    email/
        __init__.py
        receiving.py
        sending.py

Ringkasan

Dalam Python, kebolehbacaan kod adalah sangat penting. Tabiat pengaturcaraan yang buruk boleh membuat kod sukar dibaca dan dikekalkan. Dengan mengamalkan amalan pengekodan yang baik, mengelakkan komen dan panjang kod yang berlebihan, pembahagian modul, ruang kosong dan teknik organisasi kod, kami boleh menulis kod Python dengan mudah. Gunakan teknik ini untuk mencipta kod yang boleh dibaca, diperluas dan boleh diselenggara yang meletakkan asas untuk pembangunan projek masa hadapan.

Atas ialah kandungan terperinci Bagaimana untuk menyelesaikan ralat kebolehbacaan kod yang lemah dalam kod Python?. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!