Cara Penulisan Komentar dalam Kode PHP (Part IX)

Kode PHP menyediakan beberapa cara untuk menambahkan komentar yang mirip dengan cara memberikan komentar di bahasa pemrograman lain seperti C, C++ dan Unix Shell. Komentar di perlukan untuk memberikan penjelasan kepada orang lain yang membaca kode kita. Komentar sepenuhnya akan diabaikan oleh PHP pada saat eksekusi.

Walaupun kamu berfikir bahwa mungkin hanya kamu yang akan membaca kode program tersebut, namun itu adalah ide yang bagus. Beberapa sering bingung ketika memahami beberapa baris kode program setelah beberapa bulan tidak melihatnya.

Komentar yang baik adalah komentar singkat dan tidak terlalu panjang, namun memberikan penjelasan tentang kegunaan kode atau variabel tersebut dibuat.

Selain sebagai tempat membuat penjelasan, sifat komentar yang tidak akan dieksekusi oleh PHP, memberikan keuntungan lain dalam proses pembuatan program. Kebanyakan orang sering menjadikan beberapa baris kode program sebagai komentar ketika mencari tau penyebab error kode program yang sedang dibuat (proses debugging).

1. Metode Komenter Unix Shell
Disebut sebagai metode komentar Unix Shell, karena cara memberikan komentar ini berasal dari sistem Unix. Metode ini menggunakan karakter tanda pagar atau hash mark (#). PHP akan mengabaikan seluruh text yang terdapat setelah tanda pagar sampai akhir baris atau tag penutup PHP (mana yang terlebih dahulu didapati).

Karena sifatnya yang hanya mempengaruhi satu baris saja, Metode Komenter Unix Shell efektif digunakan untuk membuat komentar pendek.

<?php
$nilai = $p * exp($r * $t); # menghitung bunga majemuk
?>

Beberapa programmer juga sering menggunakan karakter # untuk memisahkan bagian kode PHP dengan bagian lainnya, seperti berikut:

#######################
## Falidasi Form Register
#######################
... Kode program PHP disini

Ketika kita membuat kode program PHP dan HTML yang saling berkaitan, Komenter Unix Shell ini bisa digunakan seperti contoh berikut:

<?php $nama = "Cowaska"; # Set $nama menjadi Cowaska ?>
<br> <?php echo $nama; ?>
... kode HTML berikutnya

2. Metode Komenter C++ 
Metode komentar ini meminjam cara membuat komentar dari bahasa pemrograman C++. Hampir sama dengan metode komentar Unix Shell, metode komentar C++ ini berlaku hanya untuk sebuah baris atau sampai tag penutup PHP, Tetapi kali ini karakter yang digunakan adalah dua kali garis miring (two slashes), yakni “//”. Karena sifatnya yang sama seperti Unix Shell, semua contoh tanda ‘#’ dapat diganti dengan ‘//’, berikut contohnya:

$nilai = $p * exp($r * $t); // menghitung bunga majemuk

/////////////////////////////
// Falidasi Form Register
/////////////////////////////
... Kode program PHP disini

<?php $nama = "Cowaska"; // Set $nama menjadi Cowaska. ?> 
<br> <?php echo $nama; ?>
... kode HTML berikutnya

Kebanyakan Orang lebih menyukai menggunakan Metode Komenter C++ ini dibandingkan dengan metode Unix Shell, karena tombolnya mudah dicapai. Untuk menekan tanda “#”, anda harus menekan tombol shift di keyboard terlebih dahulu, namun untuk mengetik tanda “//” kita tinggal menggunakan satu tangan kanan untuk mencapainya di keyboard.

3. Metode Komentar C 
Jika metode komentar Unix Shell dan C++ efektif untuk membuat komentar pendek, untuk membuat komentar yang panjang, PHP meminjamnya dari bahasa C. Metode komentar ini disebut juga tipe komentar blok karena sifatnya yang harus diberikan tanda tutup untuk mengakhiri komentar.

Untuk memulai komentar, kita menuliskan sebuah garis miring dan diikuti dengan tanda bintang (/*). Semua text setelah tanda tersebut akan dianggap sebagai komentar sampai PHP menemukan tanda tutup, yakni karakter bintang dan diikuti dengan garis miring (*/). Metode komentar C ini dapat mencakup beberapa baris.

Berikut adalah contoh penggunaan Metode Komentar C

<?php
/* Dalam bagian ini kita akan membuat
beberapa variabel dan memberikan nilai awal.
Nilai awal ini hanya sebagai contoh saja, jadi jangan dianggap serius
*/
$nama = “Wahyu”;
$a = 10;
$situs = “Cowaska”;
$b= 2012;
?>

\Metode Komentar C ini juga berguna untuk “mengomentari” beberapa baris program agar tidak dijalankan oleh PHP, Seperti contoh berikut:

<?php
$a= 3;
/*
bagian ini tidak akan dijalankan oleh PHP
$b = 7;
$c = 8;
*/
?>

Namun kita perlu berhati-hati untuk tidak membuat blok komentar yang saling bertumpuk, seperti kode berikut:

<?php
$a = 12;
/*
$j = 10; /* Ini adalah komentar */
$k = 11;
Ini adalah komentar
*/
?>

Dalam contoh diatas, PHP akan gagal menjalankan kode program dan menghasilkan error di sebabkan komentar yang saling berhimpitan (overlapping).