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

Posted on

Di panduan 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 di artikel ini yaitu baris komentar atau baris keterangan, bukan kolom komentar yang lazimnya ada di blog


Komentar di perlukan untuk memberikan penjelasan kepada orang lain yang membaca kode kita. Komentar sepenuhnya akan diabaikan oleh PHP di ketika eksekusi. Walaupun kamu berpikir bahwa mungkin hanya kamu yang akan membaca kode program tersebut, namun itu yaitu ide yang bagus. Saya sendiri sering bingung ketika memahami beberapa baris kode program setelah beberapa bulan tak melihatnya.

Komentar yang bagus yaitu komentar singkat dan tak terlalu panjang, namun memberikan penjelasan mengenai kegunaan kode atau variabel tersebut dibangun.

Selain selaku tempat membangun penjelasan, sifat komentar yang tak akan dieksekusi oleh PHP, memberikan keuntungan lain di proses penyusunan program. Saya sering menjadikan beberapa baris kode program selaku komentar ketika mencari tau penyebab error kode program yang sedang dibangun (proses debugging).

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


 1. Cara Komentar Unix Shell

Disebut selaku cara komentar Unix Shell, karena cara memberikan komentar ini berasal dari program Unix. Cara ini menggunakan karakter tanda pagar atau hash mark (#). PHP akan mengesampingkan seluruh text yang terdapat setelah tanda pagar hingga ahir baris atau tag penutup PHP (mana yang terlebih dahulu didapati).

Karena sifatnya yang hanya mempengaruhi satu baris saja, cara komenter Unix Shell tepat sasaran digunakan untuk membangun komentar pendek.

Beberapa programmer pun sering menggunakan karakter # untuk memisahkan bagian kode PHP dengan bagian lainnya, seperti berikut:

Ketika kamu membangun kode program PHP dan HTML yang saling berkaitan, Komenter Unix Shell ini dapat digunakan seperti contoh berikut:


2. Cara Komenter C++

Cara komentar ini meminjam cara membangun komentar dari bahasa pemrograman C++. Hampir sama dengan cara komentar Unix Shell, cara komentar C++ ini berlaku hanya untuk sebuah baris atau hingga tag penutup PHP, Tetapi kali ini karakter yang digunakan yaitu dua kali garis miring (two slashes), yakni “//”.

Karena sifatnya yang sama seperti Unix Shell, seluruh contoh tanda ‘#’ dapat diganti dengan ‘//’, berikut contohnya:

Saya lebih menyukai menggunakan Cara Komenter C++ ini diperbandingkan dengan cara Unix Shell, karena tombolnya gampang diperoleh. Untuk menekan tanda “#”, kamu mesti menekan tombol shift di keyboard terlebih dahulu, namun untuk mengetik tanda “//” kita tinggal menggunakan satu tangan kanan untuk mencapainya di keyboard.

3. Cara Komentar C

Bila cara komentar Unix Shell dan C++ tepat sasaran untuk membangun komentar pendek, untuk membangun komentar yang panjang, PHP meminjamnya dari bahasa C. Cara komentar ini disebut pun tipe komentar blok karena sifatnya yang mesti diberikan tanda tutup untuk mengakhiri komentar.

Untuk memulai komentar, kita menuliskan sebuah garis miring dan diikuti dengan tanda bintang (/*). Seluruh text setelah tanda tersebut akan dianggap selaku komentar hingga PHP menemukan tanda tutup, yakni karakter bintang dan diikuti dengan garis miring (*/). Cara komentar C ini dapat meliputi beberapa baris.

Berikut yaitu contoh pemakaian Cara Komentar C

Cara Komentar C ini pun bermanfaat untuk “mengomentari” beberapa baris program agar tak dijalankan oleh PHP, Seperti contoh berikut:

Namun kamu perlu berhati-hati untuk tak membangun blok komentar yang saling bertumpuk, seperti kode berikut:

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


Di di panduan belajar PHP berikutnya, saya akan membahas mengenai inti dari bahasa pemrograman PHP, yaitu variabel. Berikutnya di Tutorial Belajar PHP: Pengertian Variabel dan Cara Penulisan Variabel PHP.


Sumber https://www.duniailkom.com/