Cara Menulis Komentar dalam PHP

Komentar adalah sejenis anotasi yang bisa digunakan untuk mengklarifikasi tujuan dan maksud satu bagian kode. Ketika menggunakan PHP, ada beberapa opsi untuk menulis komentar yang dapat dipilih, dan opsi-opsi tersebut diangkat dari bahasa pemrograman lama yang populer. Ada dua opsi komentar baris tunggal dan satu opsi komentar baris ganda ala bahasa C. Anda bisa menggunakan komentar untuk mencegah satu bagian kode tertentu dijalankan, dan komentar juga bisa digunakan untuk membuat dokumentasi.

Bagian 1

Bagian 1 dari 2:

Gaya

Unduh PDF

1
Gunakan komentar baris tunggal untuk menulis komentar pendek. Jika Anda perlu meninggalkan komentar pendek, Anda dapat menggunakan kode komentar baris tunggal. Jenis komentar ini hanya berlaku hingga akhir baris atau akhir blok kode komentar. Komentar-komentar tersebut hanya berlaku untuk tanda (tag) PHP dan akan dibaca jika dituliskan dalam HTML.^{[1]XTeliti sumber}
```
 <?php  //  Ini adalah cara standar (C++) untuk membuat komentar baris tunggal#Anda juga bisa menggunakan cara Unix untuk membuat komentar baris tunggal ?>
```
2
Gunakan komentar baris ganda untuk membuat komentar yang lebih panjang atau menguji kode. Komentar baris ganda berguna untuk menulis penjelasan yang panjang atau mencegah sebagian kode untuk diproses. Lihatlah bagian "Penggunaan" di bawah untuk mendapatkan kiat-kiat dalam menggunakan komentar baris ganda.^{[2]XTeliti sumber}
```
 <?php /* Ini adalah formatkomentar baris ganda. Semua hal yang tertulis sebelum tanda penutupakan dijadikan komentar*//* Beberapa orang lebih memilih untuk menggunakan* tanda tambahan pada setiap* awal baris. Dengan begini, komentar yang besar bisa* lebih mudah dibaca, tetapi ini tidaklah wajib.*/ ?>
```
Iklan

Bagian 2

Bagian 2 dari 2:

Penggunaan

Unduh PDF

1
Gunakan komentar untuk meninggalkan catatan mengenai cara kerja kode. Anda tidak perlu melakukannya untuk setiap baris kode, karena kode yang baik seharusnya mudah dimengerti oleh pemrogram lain. Komentar berguna untuk kode yang menjalankan fungsi yang tidak biasa atau tidak jelas.^{[3]XTeliti sumber}
```
// Membuat ''request'' curl$session = curl_init($request);// Memberi tahu curl untuk menggunakan HTTP POSTcurl_setopt ($session, CURLOPT_POST, true);
```
2
Tinggalkan komentar sehingga Anda ingat tentang apa yang dibuat. Kapan pun Anda mengerjakan proyek sendiri, komentar dapat membantu untuk mengingat setiap hal yang Anda buat sebelumnya. Tinggalkan komentar pada kode yang tidak bekerja dengan baik atau kode yang belum diselesaikan.
```
// Harus meninjau ''output'' kembali sebelum melanjutkan ke tahap berikutnyaecho "Hello World!";
```

Jika Anda berencana untuk bekerja sama dengan orang lain atau ingin membuat kode Anda menjadi open-source (kode terbuka), komentar dapat membantu orang lain untuk mengerti fungsi kode dan mengetahui bagian yang terbaik untuk mengembangkan kode.^{[4]XTeliti sumber}

/* Apakah ada cara yang lebih efektif untuk menyelesaikan ini? */Gender:<input type="radio" name="gender"<?php if (isset($gender) && $gender=="female") echo "checked";?>value="female">Female<input type="radio" name="gender"<?php if (isset($gender) && $gender=="male") echo "checked";?>value="male">Male

4
Gunakan komentar untuk mencegah satu blok kode diproses. Cara ini berguna jika Anda sedang menguji sesuatu dan perlu mencegah sebagian kode tertentu berjalan. Apa pun yang berada di dalam tanda komentar akan diabaikan ketika halaman dimuat.
```
 <?php echo "/*Hello*/ World!";  /* Kata ''"Hello"'' tidak akan ditampilkan ketika kode di atas dijalankan*/  ?>
```
5
Berhati-hatilah ketika mengubah satu blok kode menjadi komentar. Fungsi komentar akan berakhir ketika sudah bertemu dengan tanda penutup yang pertama, jadi jika sudah ada komentar baris ganda di dalam kode yang Anda jadikan komentar, maka komentar tersebut akan ditutup pada akhir komentar bersarang (nested comment) yang sudah ada sebelumnya.
```
 <?php  /* echo "Hello World!"; /* Komentar ini akan mengacaukan segalanya*/*/ ?>
```
```
 <?php  /* echo "Hello World!"; // Komentar ini akan baik-baik saja*/ ?>
```

Anda dapat menggunakan format kode kreatif untuk membuat dokumentasi langsung di dalam kode. Ini berguna untuk proyek open-source.

 <?php  //============= // HEADING //=============  //------------- // Sub-Heading //-------------  /* Judul Bagian*/ # Dokumentasi bisa dituliskan di sini# Bagian kedua dapat dituliskan di sini  /* * Gunakan ini untuk menjelaskan sesuatu * yang mungkin menghabiskan banyak baris * atau bahkan beberapa paragraf. */  ?>

Tips

Komentar HTML dan PHP tidaklah sama, sehingga jika Anda menggunakan skrip (campuran dari HTML dan PHP), pastikan bahwa Anda tidak mencampurkan komentar.
Sebagai contoh, di bawah ini terdapat komentar HTML, tetapi kode tersebut masih harus mengeksekusi kode PHP. Meletakkan komentar HTML di dalam tanda PHP akan menyebabkan eror.
-