Komentar Di Python

Komentar di Python digunakan untuk menulis catatan atau penjelasan di dalam kode yang tidak akan dieksekusi oleh interpreter Python. Komentar sangat membantu programmer untuk:

• Menjelaskan apa yang dilakukan kode.
• Menambahkan informasi mengenai cara kerja kode atau fungsinya.
• Memberikan catatan tentang perbaikan atau pengembangan selanjutnya.

Ada dua jenis utama komentar di Python: komentar satu baris dan komentar multi-baris.

---

1. Komentar Satu Baris

Komentar satu baris dimulai dengan tanda #. Teks apa pun yang berada setelah # diabaikan oleh interpreter.

Contoh:

# Ini adalah komentar satu baris
print("Hello, World!")  # Ini juga komentar di akhir baris

Di contoh ini, teks setelah # tidak akan dieksekusi. Python hanya akan menjalankan perintah print("Hello, World!").

---

2. Komentar Multi-Baris

Python tidak memiliki sintaks khusus untuk komentar multi-baris. Namun, kita dapat menulis beberapa baris komentar dengan menempatkan tanda # di awal setiap baris. Alternatifnya, kita bisa menggunakan string multiline dengan tanda kutip tiga (''' atau """) untuk membuat komentar multi-baris, meskipun sebenarnya ini adalah string yang tidak digunakan dan dianggap sebagai dokumentasi.

Contoh dengan Tanda #:

# Ini adalah komentar multi-baris
# pada kode Python yang menjelaskan
# langkah-langkah yang ada di bawah ini.
print("Komentar multi-baris dengan tanda #")

Contoh dengan String Multiline:

"""
Ini adalah komentar multi-baris
yang menggunakan string multiline.
Biasanya digunakan untuk dokumentasi
fungsi atau modul.
"""
print("Komentar multi-baris dengan string multiline")

---

3. Komentar Dokumentasi (Docstring)

Di Python, string multiline (baik """ maupun ''') juga sering digunakan sebagai docstring atau komentar dokumentasi. Docstring biasanya ditempatkan di awal fungsi, kelas, atau modul untuk menjelaskan apa yang dilakukannya. Docstring dapat diakses menggunakan __doc__.

Contoh Docstring di Fungsi:

def greet():
    """
    Fungsi ini menampilkan pesan selamat datang.
    Fungsi ini tidak menerima parameter dan tidak mengembalikan nilai.
    """
    print("Selamat datang!")

# Memanggil docstring dari fungsi
print(greet.__doc__)

Output dari kode di atas adalah:

Fungsi ini menampilkan pesan selamat datang.
Fungsi ini tidak menerima parameter dan tidak mengembalikan nilai.

---

4. Tips Penulisan Komentar yang Baik

• Singkat dan Jelas: Tulis komentar yang singkat, namun cukup jelas untuk menjelaskan maksud kode.
• Hindari Redundansi: Jangan menulis komentar yang hanya mengulang apa yang sudah jelas di kode. Fokuslah menjelaskan mengapa kode ditulis seperti itu, bukan bagaimana kode bekerja.
• Gunakan Bahasa yang Konsisten: Jika memungkinkan, pilih satu bahasa yang konsisten di seluruh proyek.

Contoh Komentar yang Baik:

# Menghitung luas lingkaran menggunakan rumus pi * r^2
radius = 5
luas = 3.14 * radius ** 2
print("Luas lingkaran:", luas)

Contoh Komentar yang Redundan:

radius = 5  # radius lingkaran
luas = 3.14 * radius ** 2  # menghitung luas dengan rumus pi kali radius kuadrat
print("Luas lingkaran:", luas)

Komentar yang baik tidak perlu menuliskan hal-hal yang sudah jelas, tetapi fokus memberikan penjelasan tambahan yang mungkin tidak langsung terlihat.

---

Kesimpulan

1. Gunakan # untuk komentar satu baris.
2. Gunakan beberapa # di setiap baris atau string multiline (''' atau """) untuk komentar multi-baris.
3. Gunakan docstring (""") untuk dokumentasi fungsi, kelas, atau modul.
4. Tulis komentar yang singkat, relevan, dan mudah dipahami.

Komentar yang baik membantu membuat kode lebih mudah dibaca dan dipelihara, baik oleh Anda sendiri di masa depan maupun oleh orang lain yang mungkin akan bekerja dengan kode Anda.