Komentar pada Python

Komentar merupakan teks yang tidak dieksekusi oleh interpreter Python dan hanya berfungsi sebagai penjelasan atau dokumentasi dalam kode. Komentar sangat penting untuk memberikan pemahaman tambahan kepada pembaca atau pengembang tentang tujuan atau fungsi dari suatu bagian kode.

A. Jenis Komentar pada Python

#

Komentar terdiri dari dua jenis, yaitu:

1. Komentar Satu Baris:

   Komentar satu baris dimulai dengan tanda #. Semua teks setelah # akan dianggap sebagai komentar. Perhatikan contoh berikut:

   # Ini adalah komentar satu baris
   angka = 10  # Komentar dapat juga ditulis di sepanjang baris kode
   

2. Komentar Multi-Baris:

   Komentar multi-baris dapat ditulis dengan menggunakan tiga tanda kutip tunggal (''') atau tiga tanda kutip ganda ("""). Perhatikan contoh berikut:

   '''
   Ini adalah komentar
   multi-baris dengan
   tanda kutip tunggal
   '''
   
   """
   Ini adalah komentar
   multi-baris dengan
   tanda kutip ganda
   """
   

B. Penggunaan Komentar

#

Komentar pada kode memiliki beberapa fungsi dan kegunaan, diantaranya:

1. Penjelasan Kode

   Komentar pada kode dapat digunakan untuk menjelaskan kode. Perhatikan contoh berikut:

   # Menghitung total harga
   harga_barang = 500
   jumlah_barang = 3
   total_harga = harga_barang * jumlah_barang
   

2. Menonaktifkan Kode Sementara

   Komentar dapat juga digunakan untuk menonaktifkan sementara baris kode tertentu secara sementara. Biasanya ini dilakukan pada tahap development. Terkadang pada tahap development sebuah program, kamu akan sering menonaktifkan baris-baris tertentu baik dalam rangka testing maupun perbaikan bugs.

   # print("Baris ini sedang dinonaktifkan")
   

3. Dokumentasi Fungsi atau Modul

   Komentar juga berfungsi sebagai dokumentasi bagi fungsi atau modul sehingga jelas tujuan dan maksud dari fungsi tersebut. Hal ini akan sangat bermanfaat ketika melakukan maintenance nantinya. Fungsi dan modul yang disertai dengan dokumentasi akan lebih mudah dipahami maksud dan tujuannya. Perhatikan contoh berikut:

   def hitung_luas_persegi(panjang, lebar):
       """
       Fungsi ini menghitung luas persegi.
       Panjang dan lebar harus dalam satuan yang sama.
       """
       return panjang * lebar
   

4. Catatan Perubahan atau Revisi

   Komentar dapat digunakan juga sebagai catatan perubahan atau revisi dari sebuah file. Dengan menyertakan catatan perubahan atau revisi dari sebuah file, maka akan lebih mudah tracing ketika ada bug, khususnya jika bekerja dalam sebuah tim menggunakan sebuah repositori kode seperti git.

   # Versi 1.0 - 01/01/2023
   # - Penambahan fitur A
   # - Peningkatan kinerja modul B
   

C. Tips Penggunaan Komentar

#

1. Gunakan Komentar dengan Panjang Maksimal 72 Karakter:

   Komentas dengan panjang maksimal 72 karakter membantu dalam mempertahankan konsistensi dan kejelasan, terutama ketika membaca kode pada layar berukuran standar. Komentar yang terlalu panjang akan menutupi kode utama sehingga kode tidak lagi rapih sehingga sulit dibaca.

2. Hindari Komentar yang Menjelaskan Hal yang Sudah Jelas:

   Komentar sebaiknya memberikan informasi tambahan atau menjelaskan bagian kode yang mungkin tidak langsung jelas. Komentar pada sesuatu yang sudah jelas bersifat redundan dan hanya akan menambah jumlah baris kode.

3. Perbarui Komentar Saat Kode Diubah:

   Pastikan untuk memperbarui komentar jika ada perubahan signifikan dalam kode. Komentar yang tidak akurat bisa lebih merugikan daripada tidak ada komentar sama sekali.

Dengan memahami penggunaan komentar dan mengikuti pedoman penggunaannya, kamu dapat meningkatkan keterbacaan dan pemahaman kode Python. Komentar yang baik membantu pengembang saat pemeliharaan kode dan memudahkan kerjasama dalam tim pengembangan.