Membuat komentar didalam source code yang kita buat merupakan ide bagus. Seringkali bahkan sudah pasti bahwa suatu komentar dapat membantu pengembang untuk mengerti atau mengetahui mengapa suatu program dibuat spesifik, siapa yang membuat dan kapan suatu program tersebut dibuat. Komentar – komentar yang dibuat dapat juga mengindikasikan versi atau menjelaskan berbagai macam informasi atau dapat juga membantu pengembang untuk melakukan pemeliharaan atau bahkan pengembangan.
Dalam hal ini komentar akan diabaikan oleh kompailer pada saat melakukan kompilasi. Dengan adanya suatu komentar dapat membatu kita untuk membaca suatu kode (scripts) serta kita mendapatkan suatu informasi yang berguna.
Berikut contoh penggunaan komentar :
/*
* Contoh Program HelloWorld
*/
Selain format penulisannya yang mudah untuk dibaca, dengan adanya komentar tersebut memberikan kita berbagai informasi yang berguna. Dan juga sudah merupakan hal yang lazim memasukan komentar diawal source code sebagai informasi standar seperti penulis kode (scripts), informasi kontak, dan versi dari program yang dibuat.
Ada 3 cara dalam dalam pembuatan komentar :
Komentar satu baris
Sintak yang digunakan adalah //, diikuti komentar yang kita butuhkan. Contoh penggunaan dari komentar satu baris ini adalah sebagai berikut :
Penting yang harus kita ingat bahwa penggunaan komentar ini hanya digunakan untuk komentar dalam satu baris saja. Apabila format komentar ini digunakan lebih dari satu baris, maka setiap barisnya kita harus memberikan sintak //.
Komentar blok
Sintak yang digunakan untuk format komentar ini adalah diawali dengan sintak /* dan diakhiri */. Contoh penggunaan komentar ini adalah sebagai berikut :
/*
*Contoh Program Hello World
*/
Dengan menggunakan komentar ini dapat membantu memudahkan kita untuk mengidentifikasi setiap baris source code, ini berbeda dengan komentar satu baris yang hanya mengidentifikasi untuk satu baris source code saja.
Komentar dokumentasi
Sintak untuk komentar dokumentasi sama dengan sintak standar komentar blok, bedanya ada penambahan asterisk sebagai awal penulisan blok, contoh penulisannya adalah sebagai berikut :
/**
* Ini adalah komentar dokumentasi
* @penulis Deni
* versi 1.1
*/
Kita dapat menggunakan format komentar seperti ini untuk menjelaskan program yang dibuat sesuai dengan spesifik bagian kode (scripts) tersebut.
Posting Komentar