Tutorial PHP Dasar Part 8: Penulisan Komentar Kode PHP

Setelah sebelumnya kita sudah membahas tentang aturan penulisan kode PHP, sekarang kita akan membahas tentang penulisan komentar pada kode PHP. Ada banyak cara untuk menuliskan komentar pada script atau kode PHP. Fungsinya, untuk memberikan catatan atau tanda pada sebuah baris kode untuk mengingatkan si pembuat kode tersebut.

Penulisan Komentar Kode PHP

Dibawah ini merupakan beberapa gaya penulisan yang bisa kalian terapkan ketika ngoding menggunakan bahasa PHP.

1. Komentar Unix Shell

Metode Unix Shell berasal dari sistem Unix dan menggunakan karakter tanda pagar atau hashtag (#). Dengan menggunakan metode ini, PHP akan mengabaikan semua text yang terdapat setelah tanda pagar sampai akhir sebuah baris atau tag penutup PHP. Metode Unix Shell ini hanya efektif digunakan untuk ketika ingin membuat komentar yang pendek.

<?php 
	#ini adalah komentar baris 1
	#berikut ini adalah sebuah variabel
	$nama = "Brian Harris";
	echo $nama;
 ?>

Jika script diatas dijalankan, maka akan tampil seperti gambar dibawah ini pada browser.

Selain itu, para programmer biasanya sering menggunakan karakter # untuk memisahkan bagian kode PHP dengan bagian yang lainnya.

2. Komentar C++

Metode komentar ini mirip dengan pembuatan komentar dari bahasa pemrograman C++ dan memiliki beberapa kesamaan dengan metode komentar Unix Shell (yang akan dibahas selanjutnya), yaitu metode komentar C++ berlaku hanya untuk satu baris atau sampai tag penutup PHP. Apabila metode komentar Unix Shell menggunakan karakter #, metode C++ menggunakan karakter // (two slash). Kesamaan sifat seperti ini mirip seperti Unix Shell, semua contoh tanda # dapat diganti dengan //.

<?php 
	//ini adalah komentar baris 1
	//berikut ini adalah sebuah variabel
	$nama = "Brian Harris";
	echo $nama;
 ?>

Jika script diatas dijalankan, maka akan tampil seperti gambar dibawah ini pada browser.

3. Komentar C

Metode komentar C berguna untuk membuat komentar yang panjang. Karena sifatnya yang harus diberikan tanda tutup untuk mengakhiri komentar, metode komentar C disebut komentar tipe blok. Pada awal komentar, kita menuliskan sebuah garis miring dan diiringi dengan tanda bintang (/*). Setelah itu, semua text setelah tanda bintang (/*) akan dianggap sebagai komentar sampai PHP menemukan tanda penutup, yaitu karakter bintang dan diiringi dengan garis miring (*/). Karena penggunan ini sifatnya panjang, metode ini terdiri atas beberapa baris.

<?php 
	/* Sekarang kita akan membuat beberapa variabel untuk memberikan nilai awal. Nilai
    awal disini hanya untuk contoh saja, kita akan mainkan dalam part selanjutnya */
	 $nama = "Iltekkomputer";
	 $a = 15;
	 $nama = "Brian Harris";
	 $b = 2019;
 ?>

Selain itu, metode komentar C juga bisa digunakan untuk memberikan komentar yang bertujuan agar beberapa baris program tidak dijalankan oleh PHP.

<?php 
	$a = 1000;
	/*
	ini adalah bagian yang tidak akan
	dijalankan oleh php
	$b = 999;
	$c = 998;
	*/
 ?>

Ketika membuat blok komentar, ada baiknya kita menghindari pembuatan blok komentar yang saling bertumpul. Hal ini akan membuat PHP pusing dan gagal menjalankan kode program (error) karena disebabkan adanya komentar yang saling berhempitan atau bisa disebut dengan overlapping.

Contohnya seperti dibawah ini

<?php 
	$a = 1000;
	/*
	ini adalah komentar 1
	$b = 999;
	$c = 998; /* ini adalah komentar 2 */
	*/
 ?>

Coba lihat pada script diatas, PHP akan pusing dan bingung untuk menjalankannya sehingga kode program yang dihasilkan akan mengalami error. Karena pemblokan komentar saling bertumpul atau berhempitan.

Sampai sini kita sudah membahas mengenai komentar pada PHP. Mungkin kalian beranggapan bahwa komentar ini tidak ada gunanya, tapi jika kalian sudah terbiasa ngoding atau membuat suatu program menggunakan bahasa pemrograman tertentu, kalian akan merasakan betapa pentingnya sebuah komentar untuk sebuah baris program. Pada tutorial selanjutnya, kita akan membahas tentang Variabel dan Penulisan di PHP.