Komentar PHP

Ringkasan : dalam tutorial ini, Anda akan mempelajari cara menggunakan komentar PHP untuk mendokumentasikan kode Anda.

Komentar PHP adalah bagian penting dari kode. Komentar memberikan informasi berguna yang nantinya akan membantu Anda dan pengembang lain memahami arti kode dengan lebih cepat.

PHP mendukung dua jenis komentar:

• Komentar satu baris
• Komentar multi-baris

Komentar PHP satu baris

Komentar satu baris ditempatkan di akhir baris atau di blok saat ini.

Komentar satu baris dimulai dengan tanda pagar ( # ) atau garis miring ganda ( // ). Sisa teks setelah ( // ) diabaikan oleh penerjemah PHP.

Contoh berikut menggunakan // untuk komentar satu baris:

<?php

$rate = 100;
$hours = 173;
$payout = $hours * $rate; // payout calculation

Dan contoh berikut menggunakan # untuk komentar satu baris:

<?php

$title = 'PHP comment'; # set default title

Komentar PHP multi-baris

Komentar multi-baris dimulai dengan /* dan diakhiri dengan */. Misalnya:

<?php
/*
   This is an example of a multi-line comment,
   which can span multiple lines.
*/

Dalam praktiknya, Anda menggunakan komentar multi-baris ketika Anda perlu merentangkan komentar beberapa baris.

Menulis komentar yang bermakna

Untuk mendokumentasikan kode Anda secara efektif, Anda menggunakan pedoman berikut:

1) Membuat kode berbicara sendiri tanpa menggunakan komentar dengan memberi nama pengidentifikasi yang bermakna. Misalnya, Anda dapat menggunakan yang berikut ini:

$is_completed = true;

Daripada menggunakan nama samar dengan komentar:

$ic = true; // is completed

Kode itu sendiri bisa menjadi komentar yang bagus.

2) Jangan menulis komentar untuk menjelaskan fungsi kode, melainkan jelaskan mengapa kode melakukan hal tersebut. Misalnya:

// complete the task
$is_completed = true

3) Saat menulis komentar, buatlah sesingkat mungkin.

Ringkasan

• Komentar PHP adalah bagian penting dari kode karena menjelaskan mengapa kode melakukan apa yang seharusnya dilakukan.
• PHP mendukung komentar satu baris dan multi-baris.
• Komentar satu baris dimulai dengan # atau // .
• Komentar multi-baris dimulai dengan /* dan diakhiri dengan */.

Itulah tadi tutorial cara menggunakan Komentar PHP, mudah-mudahan bisa bermanfaat bagi Anda semua. Jangan Lupa untuk mengunjunyi YouTube Kami dan bisa bantu Subscribe ya.