Cara Penulisan Komentar Pada PHP - Belajar PHP Part 10

Cara penulisan komentar pada php tersedia dalam beberapa metode sehingga memungkinkan untuk menambahkan baris kalimat sebagai pengingat atau note terkait kode yang ditulis pada teks editor script. Penulisan komentar pada php hampir dengan cara memberikan komentar di bahasa pemrograman lain seperti C, C++, Unix Shell dan Java. Apa perlu menulis komentar pada kode php? Opsional, namun dengan adanya note komentar ini akan memudahkan jika dikemudian hari kode tersebut akan dimodifikasi, sehingga kita tahu maksud dari kode program tersebut. Oh ya, cara penulisan komentar pada php yang dimaksud dalam pembahasan ini adalah note baris komentar atau baris keterangan, bukan kolom komentar atau live chat yang umumnya ada di blog ya.

Sebelum lanjut membahas cara penulisan komentar pada php harus kita ketahui bahwa, komentar yang kita sisipkan pada kode program akan sepenuhnya diabaikan oleh PHP pada saat eksekusi. Namun tetap ada kaitannya dengan pembahasan sebelumnya tentang aturan dasar penulisan kode php, oleh karena itu aturan main menulis komentar pada kode php perlu kita bahas. Ini sangat penting, bahkan beberapa programmer menjadikan note komentar pada kode program itu sendiri dengan tujuan untuk mempermudah troubleshoot atau proses debugging.

Cara Penulisan Komentar Pada PHP

komentar pada php

cara penulisan komentar pada php

Berikut adalah tutorial belajar php tentang cara penulisan komentar pada php dalam beberapa metode yang perlu diperhatikan, sehingga mudah dibaca dan kode program tetap dapat berjalan dengan baik.

1. Metode Komentar Unix Shell.

Karena cara memberikan komentar pada kode php ini berasal dari sistem Unix, maka metode ini disebut metode komentar Unix Shell, 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 kode php tergantung mana yang terlebih dahulu didapati.

Metode komentar unix shell sifatnya yang hanya mempengaruhi satu baris saja, sehingga metode ini efektif digunakan untuk membuat komentar pendek. Sebagaimana contoh berikut;

<?php
	$luas	=2 * ($pl + $pt + $lt); # menghitung luas permukaan balok
?>

Kemudian beberapa programmer juga melakukan cara penulisan komentar pada php dengan menggunakan karakter # untuk memisahkan bagian kode php dengan bagian lainnya, seperti contoh di bawah ini.

#########
### Tampilkan tanggal hari ini
#########
<?php
	echo date("d F Y");
?>

Bagaimana cara penulisan komentar jika pada script terdapat kode program PHP dan HTML yang saling berkaitan? maka komenter Unix Shell seperti contoh di bawah ini yang dapat digunakan.

<?php $username	="rajaputramedia"; # Set $username menjadi rajaputramedia ?>
<br />
<?php echo $username;?>
kode HTML berikutnya disini ...

2. Metode Komenter C++.

Cara penulisan komentar pada php selanjutnya adalah dengan metode C++, karena metode komentar ini meminjam cara membuat komentar dari bahasa pemrograman C++. Hampir sama dengan metode komentar Unix Shell, metode komentar C++ berlaku hanya untuk sebuah baris atau sampai tag penutup kode php, akan tetapi karakter yang digunakan adalah dua kali garis miring atau double slashes seperti ini "//".

Karena sifatnya sama seperti Unix Shell yang hanya berbeda pada karakternya saja, maka semua contoh penulisan komentar pada php dengan tanda "#" dapat diganti dengan karakter "//". Sebagaimana contoh berikut ini;

<?php
	$luas	=2 * ($pl + $pt + $lt); // menghitung luas permukaan balok
?>

//////////////////
////// Tampilkan tanggal hari ini
//////////////////
<?php
	echo date("d F Y");
?>

<?php $username	="rajaputramedia"; // Set $username menjadi rajaputramedia ?>
<br />
<?php echo $username;?>
kode HTML berikutnya disini ...

Mungkin teman-teman setuju bahwa metode komenter C++ lebih friendly dibandingkan dengan metode Unix Shell, tahu apa alasannya?. Untuk membuat tanda "#", kita harus menekan tombol shift pada keyboard terlebih dahulu dan tahan hingga tanda "#" di tekan, jauh lebih mudah dan cepat mengetik tanda "//" yang cukup dengan satu jari tangan kanan saja.

3. Metode Komentar C.

Cara penulisan komentar pada php dengan metode ini berbeda peruntukannya dengan metode komentar Unix Shell dan C++ yang cukup efektif untuk membuat komentar pendek. Akan tetapi untuk membuat komentar yang panjang PHP meminjamnya dari bahasa C yang disebut dengan metode komentar C, yang juga disebut sebagai tipe komentar blok karena sifatnya yang harus diberikan tanda tutup untuk mengakhiri komentar.

Untuk memulai komentar, kita dapat menuliskan satu garis miring dan diikuti dengan tanda bintang "/*". Kemudian semua text setelah tanda tersebut akan dianggap sebagai komentar sampai PHP menemukan tag pentutup, yakni karakter bintang dan diikuti dengan garis miring "*/". Komentar pada metode ini dapat ditulis menjadi beberapa baris sesuai kebutuhan. Sebagaimana contoh di bawah ini;

<?php
	/* Perhatian
	Dalam kode php ini terdapat beberapa variabel dan nilai awal.
	Anda dapat mencotoh atau memodifikasinya
	*/
	$nama="Andi";
	$a	=10;
	$website	="rajaputramedia";
	$b	=2014;
?>

Seperti yang lain, cara penulisan komentar pada php dengan metode komentar C ini juga berguna untuk menjadikan beberapa baris kode program menjadi sebuah komentar agar tidak di eksekusi oleh PHP, perhatikan contoh berikut ini.

<?php
	$a	=5;
	/*
	bagian ini tidak akan di eksekusi oleh php
	$b	=3;
	$c	=9;
	*/
?>

Namun kadang karena terburu-buru atau kurang teliti dalam membuat blok komentar, hasilnya komentar yang dibuat malah bertumpuk, sehingga PHP gagal menjalankan kode program. Pasti hasilnya error dan disebabkan oleh komentar itu sendiri, seperti contoh berikut.

<?php
	$a	=11;
	/*
	$x	=20; /* Ini adalah komentar */
	$y	=7;
	Ini adalah komentar tapi overlapping. lebih teliti lagi ...
	*/
?>

Meskipun hanya sebuah note, cara penulisan komentar pada php ini perlu kita patuhi dan tidak melanggar aturan mainnya. Jika teman-teman tidak bisa ramah dengan note komentar ini, sebaiknya jangan digunakan sekalian, dari pada terjadi error atau overlapping pada kode program.

Tutorial Cara Penulisan Komentar Pada PHP

Sekian penjelasan dari kami tentang tutorial belajar php part 10 tentang cara penulisan komentar pada php yang membutuhkan ketelitian dan gaya penulisan yang rapih agar mudah dibaca dikemudian hari. Jika ada pertanyaan lebih lanjut atau hal lain yang terkait, silahkan hubungi kami melalui SMS atau email atau melalui form komentar dan obrolan. Semoga dapat membantu.

Baca juga :