Otak Coding
Source Code Aplikasi & Template Lengkap

Cara Penulisan Komentar Pada PHP

Cara Penulisan Komentar Pada PHP

  • PHP

Cara Penulisan Komentar Pada PHP

Pada materi kali ini akan dibahas mengenai cara penulisan komentar pada PHP. Sama halnya dengan bahasa pemrograman lain, PHP juga memliki komentar yang fungsinya antara lain sebagai pemberitauan keterangan kode php yang kita gunakan kepada orang lain.

Komentar akan diabaikan oleh PHP ketika program yang kita buat dijalankan. Komentar ini sangat berguna untuk mmeberikan keterangan kode yang kita buat, mengingat beberapa kode PHP yang mungkin sulit untuk kita ingat. Dengan adanya komentar kita akan terbantu  ketika kita melihat code tersebut.

Penulisan komentar yang baik adalah komentar yang singkat dan jelas tapi terpaku pada kode yang kita inginkan. Komentar bersifat tidak dieksekusi oleh PHP, hal ini meberikan keuntungan lain bagi kita dalam mendevelop aplikasi. Karena saya sendiri sering memberikan komentar pada kode program ketika mencari erro aplikasi.

Dalam pemrograman PHP ada beberapa cara penulisan komentar pada PHP yang sering digunakan dan penulisannya sering dijumpai di pemrograman propular lain seperti C, C++ dan beberapa pemrograman lainnya.

Metode Komentar dengan Karakter Tanda Pagar/Hash Mark (#)

Penulisan menggunakan karakter Hash Mark (#) sering dijumpai di Unix Shel. Komentar dengan metode ini juga sering dikenal metode kementar Unix Shel. Bahasa pemrograman PHP akan mengabaikan seluruh text yang berada setelah tanda hash mark. Berikut contohnya :

<?php
# ini adalah komentar
echo "hallo word";
?>

dari conoh diatas, kalimat "ini adalah komentar" tidak akan dijalankan karena berada dalam tanda hash mark (#). sedangkan perintah selanjutnya akan dieksekusi oleh PHP. Untuk contoh lain penulisan komentar dengan model hash mark adalah sebagai berikut :

<?php
echo "hallo word"; # ini adalah komentar
?>

ketika contoh ini dijalankan perintah akan sama dengan code di contoh pertama.

Metode Komentar dengan Karakter Tanda Dua Garis Miring (//)

Penulisan model dua garis miring sering dijumpai di bahasa pemrograman C++, Fungsinya sama dengan model komentar sebelumnya. komentar model hanya berjalan perbaris saja. cntohnya :

<?php
// ini adalah komentar1
// ini adalah komentar2
echo "hallo word";
?>

dari contoh ini kalimat "ini adalah komentar 1 dan ini adalah komentar 2" akan diabaikan pada saat kita menjalankan programan yang kita buat. sedangkan code selanjutnya akan dijalankan. contoh lain dari penulisan ini adalah :

<?php
echo "hallo word"; // ini adalah komentar1
// echo "hallo word";
?>

Metode Komentar dengan Karakter Garis Miring Diikuti dengan tanda Bintang (/*)

Jenis kometar dengan model ini dijumpai di bahasa pemrograman C. jenis komentar model ini fungsinya untuk membuat komentar yang panjang. komentar menggunakan tanda garis miring diikuti dengan tanda bintang juga dikenal dengan tipe komentar blok karena sifatnya harus diakhiri tanda tutup untuk mengakhiri sebuah komentar yang dibuat.

Untuk menulis sebuah komentar dengan model ini kita terlebih dahulu membuat /*, semua teks yang berada dalam kode ini akan dianggap komentar oleh PHP sampai ditemukannya tanda penutup */. Berikut contohnya :

<?php
/* ini adalah komentar
dalam code ini akan mencetak
hallo word*/
echo "hallo word";  
?>

Dari contoh diatas dapat dilihat bahwa penulisan komentar ini bisa digunakan untuk beberapa baris komentar. Dalam menggunakan penulisan komentar dengan model ini saya berharap untuk lebih jeli. Karena model ini bertipe blok. jadi diharapkan untuk tidak lupa menutup kode komentar berjenis ini.

Kesimpulan

Dalam bahasa pemrograman tentunya memiliki teknik penulisan yang berbeda maupun hampir sama. Komentar ini dalam satu bisa sangat membantu kita dalam memahami kode PHP ataupun sangat membantu kita dalam menemukan error program yang sedang dikerjakan. Namun penggunakan komentar yang berlebihan akan membuat file dari code program php lebih besar. Jadi saya berharap dalam mengembangkan aplikasi supaya menggunakan komentar ini dengan bijak.