Kode yang baik bukan hanya kode yang bisa dijalankan, tetapi juga kode yang mudah dipahami orang lain — atau bahkan diri kita sendiri di masa depan. Untuk itu, Python menyediakan dua jenis cara untuk menambahkan penjelasan dalam kode: komentar (#) dan docstring (""" """). Meskipun mirip tujuannya, keduanya memiliki peran dan tempat penggunaan yang berbeda.

Komentar (#): Penjelasan Satu Baris

Komentar dalam Python dimulai dengan simbol #. Segala teks setelah # dalam baris tersebut akan diabaikan oleh interpreter. Gunakan komentar untuk:

• Menjelaskan maksud dari kode yang tidak langsung jelas

• Memberi catatan TODO, FIX, atau peringatan

• Menonaktifkan baris kode sementara

Contoh Penggunaan Komentar:

# Menghitung luas lingkaran
jari_jari = 7
luas = 3.14 * jari_jari ** 2
print(luas)

Docstring (""" "): Dokumentasi Resmi Fungsi

Berbeda dengan komentar biasa, docstring digunakan untuk memberi dokumentasi internal pada fungsi, class, atau module. Docstring ditulis dalam triple quotes (""") dan langsung ditempatkan di baris pertama setelah definisi fungsi.

Contoh Docstring:

def luas_persegi(sisi):
    \"\"\"Menghitung luas persegi dari panjang sisi.\"\"\"
    return sisi * sisi

Fungsi di atas akan tetap bisa diakses deskripsinya menggunakan help(luas_persegi).

Best Practice Menulis Komentar dan Docstring

• Gunakan komentar hanya jika kode tidak cukup menjelaskan diri sendiri

• Gunakan docstring untuk menjelaskan apa yang dilakukan fungsi, bukan bagaimana

• Tulis docstring dalam bentuk kalimat lengkap

• Hindari komentar yang tidak berguna, seperti # menjumlahkan a dan b tepat di atas a + b
   

Dengan menerapkan komentar dan docstring yang efektif, kamu tidak hanya membuat kode berjalan dengan baik, tetapi juga membuatnya mudah dibaca, dipelajari, dan dipelihara. Komentar yang tepat dapat menghemat banyak waktu saat revisi, dan docstring yang baik akan membantu siapa pun memahami fungsi yang kamu tulis — termasuk dirimu sendiri.