Cara Memberikan atau Menuliskan Komentar di Bahasa Pemrograman C

Cara Memberikan atau Menuliskan Komentar di Bahasa Pemrograman C

Komentar dalam bahasa pemrograman digunakan untuk memudahkan pembacaan alur proses dari sebuah program, seorang programmer sebaiknya menuliskan komentar-komentar di dalam sintak program tersebut. Komentar program itu sendiri adalah bagian (berupa teks) di dalam program  yang tidak ikut dieksekusi pada saat proses kompilasi. Tidak seperti bahasa pemrograman lainnya lainnya seperti Pascal, C++, Java dan lainnya yang memiliki beberapa cara untuk pembuatan komentar program, bahasa C hanya menyediakan sebuah cara, yaitu dengan menggunakan menuliskan tanda ‘/*’ dan mengakhirinya dengan tanda ‘*/’. Artinya, setiap teks yang berada di belakang tanda /* akan dianggap sebagai komentar sampai ditemukan tanda */.

Jenis komentar yang terdapat dalam bahasa C ini dapat digunakan untuk komentar yang banyaknya hanya satu baris, dua baris atau lebih, bahkan bisa juga berfungsi sebagai komentar yang bersifat sisipan. Untuk lebih memahaminya, perhatikan contoh pembuatan komentar-komentar program di bawah ini.

/* Komentar program yang banyaknya satu baris */

/* Komentar program
   yang banyaknya dua baris */

/* Komentar program 
   yang banyaknya 
   tiga baris */ 

Komentar juga pada umumnya bisa digunakan untuk menuliskan deskripsi dari file kode yang mereka buat, misalnya sebagai berikut.

/* --------------------------------------------- */
/* Nama File   : test.c      */
/* Oleh    : sanabila.com  */
/* Dibuat tanggal  : 28 April 2015  */ 
/* ---------------------------------------------  */

Komentar dalam bahasa C juga terbagi menjadi dua, yaitu komentar bersarang dan komentar sisipan.

A. Komentar Bersarang

Ada beberapa kompilator C/C++ ada yang mendukung adanya pembuatan komentar yang bersarang (nested comment). Meskipun demikian Anda harus berhati-hati dalam menuliskan komentar seperti ini. Perhatikan contoh penulisan komentar program di bawah ini.

/* Ini adalah komentar /*beruntun*/ di dalam program yang ditulis dengan bahasa C */ 

Pada penulisan komentar di atas, yang dikenali sebagai komentar hanya teks ‘Ini adalah komentar /*beruntun’  dan teks sisanya, yaitu ‘di dalam program yang ditulis dengan bahasa C */  akan dianggap sebagai variabel-variabel yang tidak dikenali oleh kompilator. Hal ini disebabkan karena tanda */ akan  mengakhiri tanda /* yang pertama, dan ini tentu akan menyebabkan terjadinya kesalahan pada saat proses kompilasi. Untuk itu, apabila kompilator C yang Anda gunakan mendukung penulisan komentar bersarang, sebaiknya hindari penggunaannya di dalam program.

B. Komentar Sisipan

Dalam kasus-kasus tertentu kita juga dapat menggunakan komentar program yang merupakan komentar sisipan, artinya komentar tersebut berada di tengah-tengah baris program. Berikut ini contoh pembuatan komentar sisipan yang dimaksud di sini.

int /* Ini adalah komentar sisipan */ X; 

Meskipun hal tersebut diperbolehkan oleh kompilator, namun sebaiknya Anda menghindari penggunaannya. Alasannya adalah, komentar seperti itu justru akan mempersulit pembacaan alur proses dari sebuah program. Dengan demikian, seharunya Anda menuliskan komentar tersebut di bagian atas baris program ataupun setelah baris program berakhir, misalnya sebagai berikut.

/* Mendeklarasikan variabel X */
int X; 

atau
 
int X; /* Mendeklarasikan variabel X */