Komen dan Kebolehbacaan Kod

Komen berbilang baris boleh ditulis menggunakan tanda petikan tiga kali (''' atau """). Sebagai contoh:

"""
This is a multi-line comment.
It spans multiple lines.
"""
print("Hello, World!")

Komen membantu dalam:

• Menerangkan kod yang kompleks.
• Menjadikan kod lebih mudah difahami oleh orang lain dan diri anda pada masa hadapan.
• Menyahpepijat dan menyelesaikan masalah.

Ingat, komen adalah untuk manusia, bukan untuk mesin!

Berikut ialah beberapa petua untuk menulis komen yang baik:

• Pastikan komen ringkas dan bermakna.
• Elakkan komen yang jelas seperti # Increment x by 1 untuk x = x + 1.
• Gunakan komen untuk menerangkan sebab kod ditulis dengan cara tertentu.

Kod yang mudah dibaca lebih mudah diselenggara dan dinyahpepijat. Berikut ialah beberapa petua:

• Gunakan nama pemboleh ubah dan fungsi yang bermakna.
• Pastikan baris kod pendek.
• Susun kod mengikut bahagian menggunakan komen.

Anda boleh menggunakan komen untuk menyahaktifkan kod buat sementara waktu bagi tujuan penyahpepijatan. Sebagai contoh:

# print("This line is commented out and won’t run.")
print("This line will run.")

Anda boleh menggunakan komen untuk mendokumentasikan fungsi dan menerangkan tujuannya:

def greet(name):
    # This function greets the user by their name.
    print("Hello,", name)

greet("Alice")

Dalam pelajaran ini, anda telah mempelajari:

• Cara menulis ulasan satu baris dan berbilang baris dalam Python.
• Kepentingan ulasan untuk kebolehbacaan dan kebolehselenggaraan kod.
• Amalan terbaik untuk menulis ulasan dan meningkatkan kebolehbacaan kod.

Syabas! Mari teruskan ke topik seterusnya.