Pengantar Komentar dan Keterbacaan Kode

Komentar digunakan untuk menjelaskan kode dan membuatnya lebih mudah dibaca. Komentar diabaikan oleh penerjemah Python dan tidak memengaruhi eksekusi program.

Dalam pelajaran ini, Anda akan mempelajari cara menggunakan komentar dan menulis kode yang rapi serta mudah dibaca.

Komentar Satu Baris

Komentar satu baris dimulai dengan #. Semua hal setelah # pada baris tersebut diabaikan oleh Python. Sebagai contoh:

# This is a single-line comment
print("Hello, World!")

Komentar Multibaris

Komentar multibaris dapat ditulis menggunakan tanda kutip tiga (''' atau """). Sebagai contoh:

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

Mengapa Menggunakan Komentar?

Komentar membantu dalam:

• Menjelaskan kode yang kompleks.
• Membuat kode lebih mudah dipahami oleh orang lain dan oleh Anda di masa mendatang.
• Menelusuri kesalahan dan memecahkan masalah.

Ingat, komentar ditujukan untuk manusia, bukan mesin!

Praktik Komentar yang Baik

Berikut beberapa kiat untuk menulis komentar yang baik:

• Jaga komentar agar ringkas dan bermakna.
• Hindari komentar yang sudah jelas, seperti # Increment x by 1 untuk x = x + 1.
• Gunakan komentar untuk menjelaskan alasan kode ditulis dengan cara tertentu.

Meningkatkan Keterbacaan Kode

Kode yang mudah dibaca lebih mudah dipelihara dan ditelusuri kesalahannya. Berikut beberapa kiat:

• Gunakan nama variabel dan fungsi yang bermakna.
• Jaga agar baris kode tetap pendek.
• Atur kode menjadi beberapa bagian menggunakan komentar.

Menonaktifkan Kode dengan Komentar

Anda dapat menggunakan komentar untuk menonaktifkan kode sementara untuk keperluan penelusuran kesalahan. Sebagai contoh:

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

Contoh: Mendokumentasikan Fungsi

Anda dapat menggunakan komentar untuk mendokumentasikan fungsi dan menjelaskan tujuannya:

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

greet("Alice")

Apa yang Telah Kita Pelajari?

Dalam pelajaran ini, Anda telah mempelajari:

• Cara menulis komentar satu baris dan multibaris dalam Python.
• Pentingnya komentar untuk keterbacaan dan kemudahan pemeliharaan kode.
• Praktik terbaik untuk menulis komentar dan meningkatkan keterbacaan kode.

Bagus sekali! Mari lanjut ke topik berikutnya.