Tutorial Belajar PHP Part 10: Cara Penulisan Komentar dalam Kode PHP

Pada tutorial Belajar PHP kali ini kita akan membahas cara penulisan komentar di dalam kode PHP. PHP menyediakan beberapa cara untuk menambahkan baris komentar yang mirip dengan cara memberikan komentar di bahasa pemrograman lain seperti C, C++ dan Unix Shell.

Komentar yang dimaksud dalam artikel ini adalah baris komentar atau baris keterangan, bukan kolom komentar yang biasa ada di blog.

Komentar di perlukan untuk memberi penjelasan kepada orang yang membaca kode kita. Komentar sepenuhnya akan diabaikan oleh PHP pada saat eksekusi. Walaupun kode yang dibuat tidak akan dibaca orang lain, baris komentar tetap membantu. Saya sendiri sering bingung ketika memahami beberapa baris kode program setelah beberapa bulan tidak melihatnya.

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

PHP menyediakan beberapa cara untuk membuat komentar yang semuanya berasal dari bahasa pemrograman populer lain seperti C, C++, dan Unix Shell.

 1. Metode Komentar 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 cocok dipakai 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 anda membuat kode program PHP dan HTML yang saling bergabung, Komenter Unix Shell ini bisa digunakan seperti contoh berikut:

<?php $nama = "duniailkom"; # Set $nama menjadi duniailkom ?>
<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 = "duniailkom"; // Set $nama menjadi duniailkom. ?> 
<br> <?php echo $nama; ?>
... kode HTML berikutnya

Saya pribadi lebih menyukai metode komentar C++ dibandingkan unix shell. Alasannya semata-mata karena mudah diketik. Untuk menekan tanda pagar “#”, kita harus menekan tombol shift di keyboard terlebih dahulu, namun untuk mengetik tanda “//“, tinggal menggunakan satu jari untuk mencapainya.

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 diberi tanda tutup untuk mengakhiri komentar.

Untuk memulai komentar, tulis satu 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 = "Andi";
$a = 10;
$situs = "duniailkom";
$b= 2014;
?>

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 anda 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
*/
?>

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

Di dalam tutorial belajar PHP berikutnya, saya akan membahas tentang inti dari bahasa pemrograman PHP, yaitu variabel. Selanjutnya pada Tutorial Belajar PHP: Pengertian Variabel dan Cara Penulisan Variabel PHP.