Pada artikel ini akan saya tulis tentang cara menulis komentar dalam proses pembuatan kode program PHP. Sebetulnya ini adalah artikel yang seharusnya ditulis diawal-awal tutorial dasar PHP namun kemarin sempat terlewatkan.
Komentar program yang dimaksud disini bukan seperti komentar pada blog, namun yang dimaksud adalah kata-kata yang terdapat pada kode program PHP yang berguna untuk mengomentari kode program yang dijalankan. Jadi meski ditulis pada source code PHP, kode pomentar program tidak akan dijalankan.
Tujuan dari penggunaan komentar pada kode program adalah untuk menjelaskan tentang sebuah
kode program PHP yang ditulis kepada pembaca program dalam hal ini bisa kita sendiri atau orang lain. Jika menjelaskan kepada orang lain mungkin wajar ya, namun mengapa perlu menjelaskan kepada diri kita sendiri? bukankan kita sudah paham akan program yang kita buat sendiri. Hal ini dikarenakan semakin banyak kita membuat program dan semakin rumit alur program terkadang kita lupa pada alur program yang kita buat sendiri.
Selain dari hal diatas,,komentar pada kode
program berfungsi juga untuk memberi informasi pada sebuah file PHP, seperti judul, kapan dibuat dan siapa yang buat serta tujuan dari script PHP tersebut dibuat. Komentar program juga bisa berfungsi saat melakukan debug atau mencari kesalahan saat membuat program. Biasanya kode-kode yang dianggap bermasalah akan di-skip dulu menjadi sebuah komentar sehingga tidak ikut dijalankan.
Ada beberapa cara yang bisa dipilih untuk membuat komentar pada kode program PHP. Bisa dengan tanda # (hash) seperti pada pemrograman shell Unix atau tanda // seperti pada pemrograman bahasa C. Tanda # dan // berguna jika akan untuk membuat komentar dalam sebaris dua baris saja. Jika ingin membuat komentar dalam beberapa baris bisa diapit menggunakan tanda /* … */ seperti pada pemrograman bahasa C.
Untuk pemakaian sehari hari saya lebih memilih menggunakan tanda // dibanding tanda # karena mudah dan efisien dalam pengetikan. Hal ini karena untuk membuat tanda # perlu menekan dua tombol yaitu shift dan 3. Selain itu tanda // juga banyak digunakan pada contoh-contoh program PHP yang dishare pada beberapa blog dan website diinternet.
Contoh membuat komentar dengan tanda #
<?phpecho "Saya BISA"; # ini adalah perintah menampilkan teks Saya BISA
?>
atau
<?php
# ini adalah perintah menampilkan teks Saya BISA
echo "Saya BISA";
?>
Contoh membuat komentar dengan tanda //
<?phpecho "Saya BISA"; // ini adalah perintah menampilkan teks Saya BISA
?>
atau
<?php
// ini adalah perintah menampilkan teks Saya BISA
echo "Saya BISA";
?>
Contoh membuat komentar dengan tanda /* … */
<?phpecho "Saya BISA"; /* ini adalah perintah menampilkan teks Saya BISA */
?>
atau
<?php
/* ini adalah perintah menampilkan teks Saya BISA */
echo "Saya BISA";
?>
atau
<?php
/* Ini adalah contoh komentar program dalam tiga baris
Kode dibwah ini adalah perintah menampilkan teks "Saya BISA"
Ini masih termasuk komentar program
*/
echo "Saya BISA";
?>
Referensi:
- //www.duniailkom.com/cara-penulisan-komentar-dalam-kode-php/
Komentar dalam pemrograman menjadi salah satu aspek yang penting agar script yang ditulis mudah untuk di develop kembali atau juga dalam proses debugging. untuk menulis komentar di source code itu berbeda disetiap bahasa pemrograman , jadi ada aturannya sendiri agar komentar tidak dianggap sebagai statement/perintah.
Untuk artikel ini saya hanya akan membahas tentang cara membuat komentar di 3 bahasa utama dalam membuat sebuah website yaitu HTML , PHP dan JavaScript. oke langsung ajah berikut caranya.
Memberi Komentar di HTML
Penulisan komentar di html menggunakan tanda baca ini <!– … –> seperti contoh di bawah :
MEMBERI KOMENTAR DI PHP
Selanjutnya penulisan di PHP , ada 3 cara untuk menulis komentar di PHP berikut detailnya
// garis miring untuk menulis komentar dalam satu baris #pagar juga dalam satu baris /* Sedangkan garis miring dan bintang digunakan untuk menulis komentar dalam Beberapa baris */Memberi komentar di CSS
untuk penullisan di CSS menggunakan tanda baca garis miring dengan bintang /* … */ , seperti contoh di bawah
/* Membuat Komentar di CSS */Memberi Komentar di JavaScript
Terakhir cara memberi komentar di JavaScript, penulisannya sama seperti di php
/* garis miring dan bintang untuk multiple baris */ //sedangkan garis miring dua untuk satu barisoke sekian penjelasan tentang cara menyisipkan komentar dalam kodingan, semoga bermanfaat.