Apakah kita perlu membuat comment pada setiap statment di coding yang kita buat?

Dalam sebuah coding di dalam sebuah program. Terkadang kita melihat beberapa komentar di baris tertentu yang diselipkan oleh pembuat program tersebut. Lantas apakah sebenarnya kita perlu membuat komentar pada coding bahkan pada setiap algortima dan pernyataan yang kita buat?

Dalam semua bahasa pemrograman(yang menyediakan fitur Comment) Komentar adalah bagian dari kode program yang tidak ikut dibaca / diterjemahkan pada saat proses kompilasi. dengan kata lain, komentar tidak akan mempengaruhi jalannya program, karena hanya berguna untuk mempermudahkan kita dalam mengingat dan menjelaskan kode / deskripsi program.

Fungsi komentar

Salah satu fungsi komentar dalam bahasa pemrograman pada umumnya pada khususnya adalah sebagai berikut:

  • Menjelaskan algoritma dan keterangan-keterangan yang diperlukan dalam program sehingga program menjadi lebih mudah dipahami oleh yang melihatnya

  • Membantu dalam proses pemeliharaan (maintenance) dari program yang telah kita buat, sehingga proses maintenance menjadi lebih cepat karena dengan adanya komentar kita dapat lebih cepat mengetahui fungsi dari sebuah program.

  • Menuliskan informasi tentang kode program, misalnya nama nama pembuat kode program, kapan kode tersebut dibuat / dimodifikasi, lisensi dari program tersebut, maupun deskripsi lain yang diperlukan.

  • Mempermudahkan kita dalam mengingat kembali dan menjelaskan kode / deskripsi program pada program yang di buat

  • Mempermudahkan programmer lain dalam memahami program yang kita buat.

Dari uraian di atas, dapat disimpulkan bahwa komentar perlu kita sisipkan dalam coding yang kita buat karena fungsi-fungsi komentar yang memudahkan kita dan orang lain dalam memrogram ulang ataupun memahami coding yang kita buat. Lalu apakah kita harus membuat komentar pada setiap statment dari coding kita? Itu tergantung dari algoritma atau statment yang dibuat, semakin kompleks algoritma tersebut semakin kita harus membuat komentar untuk mempermudah pekerjaan kita.

Perlu atau tidak perlunya comment tergantung dalam pembuatan program, entah program tersebut digunakan untuk jangka panjang atau jangka pendek, berkelompok atau individual, untuk individu atau public, dll faktor-faktor lain. Walau sebaiknya pemrograman yang baik dan terstruktur sebaiknya selalu menuliskan comment.
Berikut adalah kegunaan comment:

  1. Untuk menonaktifkan suatu bagian kode untuk sementara.
  2. Sebagai pengingat tentang apa yang script lakukan.
  3. Untuk menambahkan placeholder dimana untuk ditambahkan kode nantinya.
  4. Menuliskan informasi tentang kode program.
  5. Memudahkan programmer untuk melihat kodingan dari programmer lain.

Mungkin ketika script masih ingat di pikiran, comment akan sangat mengganggu . Namun, jika kamu butuh untuk membuka kodingan yang dibuat beberapa bulan yang lalu untuk merevisi kode misalnya, maka kamu akan sangat terbantu dengan adanya comment tersebut, dimana kamu hanya dengan membaca comment tersebut pasti akan langsung paham daripada membaca kodenya dari awal. Apalagi jika kita memiliki banyak rangkaian kode, ini sangat membantu dalam pembuatan program. Comment amat sangat penting juga saat kamu bekerja dalam suatu kelompok, karena akan sangat membantu rekan kerja untuk memahami kode yang dimaksudkan. Sehingga rekan kerja akan mudah memahami kode tersebut tanpa bertanya ke pembuatnya.

Comment di bahasa pemrograman tidak mempengaruhi fungsi dari kodingan kita, dan juga compiler akan mengabaikan bentuk comment yang dibuat. Sehingga hal tersebut merupakan keuntungan tersendiri karena walau kita menggunakan banyak comment, tidak mempengaruhi cepat lambatnya program. Memang terdapat kekurangan yaitu pada efisiensi waktu, tapi untuk jangka panjang, comment akan sangat berguna. Comment yang umum di bahasa pemrograman adalah //.

Berikut adalah empat tipe comments yaitu
• Full-line comments
• End-of-line comments
• Block or multiple-line comments
• Mega-comments


http://www.gavilan.edu/csis/languages/comments.html

Powers, David.2010.PHP Solutions: Dynamic Web Design Made Easy, Second Edition. New York: Friendsof

Komentar atau comment adalah naskah program yang tidak akan diproses oleh compiler. Pada saat proses kompilasi berlangsung, teks program yang termasuk ke dalam komentar akan diabaikan oleh compiler. Kehadiran komentar di dalam program sangat dibutuhkan terutama jika program yang dibuat sudah masuk ke skala besar dan kompleks.

Setidaknya ada 3 alasan menagapa komentar perlu ditulis :

  1. Dokumentasi
  2. Debugging
  3. Maintenance

Dalam proses pengembangan sebuah program, tentunya kita akan disibukkan dengan penulisan kode-kode yang begitu banyak dan ‘tampak’ rumit sehingga akan sulit untuk dipahami oleh orang lain. Untuk menangani masalah ini, sebagai programmer kita sebaiknya menambahkan komentar untuk menjelaskan algoritma dan keterangan-keterangan yang diperlukan dalam program sehingga program menjadi lebih mudah dipahami oleh yang melihatnya. Hal ini juga akan membantu dalam proses pemeliharaan (maintenance) dari program yang telah kita buat.

Selain kebutuhan diatas komentar juga banyak digunakan untuk menuliskan informasi tentang kode program, misalnya nama nama pembuat kode program, kapan kode tersebut dibuat / dimodifikasi, lisensi dari program tersebut, maupun deskripsi lain yang diperlukan.