Saat menulis program, kode yang rapi dan mudah dibaca sangat membantu, terutama kalau kamu kembali membuka file itu seminggu (atau sebulan) kemudian. Salah satu cara menjaga keterbacaan adalah dengan menggunakan komentar dan menerapkan konvensi penulisan kode.
๐ 1. Apa Itu Komentar?
Komentar adalah catatan di dalam kode yang tidak akan dieksekusi oleh PHP. Fungsinya:
Memberi penjelasan logika kode
Menandai bagian penting
Mempermudah kerja tim (atau diri sendiri di masa depan!)
โ๏ธ 2. Jenis Komentar di PHP
PHP mendukung dua jenis komentar:
a) Komentar satu baris (// atau #)
php
Salin
Edit
// Ini adalah komentar satu baris
# Komentar juga bisa pakai tanda pagar
$nama = "Budi"; // Menyimpan nama pengguna
b) Komentar banyak baris (/* ... */)
php
Salin
Edit
/*
Ini komentar panjang
yang bisa menjelaskan beberapa baris kode
*/
echo "Halo Dunia!";
๐ 3. Tips Penulisan Kode yang Rapi
Menulis kode itu seperti menulis artikel — harus mudah dipahami.
Berikut beberapa tipsnya:
โ Gunakan indentasi konsisten
if ($a > 0) {
echo "Positif";
}
โ Gunakan spasi untuk kejelasan
$total = $harga * $jumlah;
โ Hindari nama variabel seperti $a, $b, $c tanpa konteks
$nama_pengguna = "Ani";
โ Pisahkan blok logika secara visual
// Hitung total
$total = $harga * $jumlah;
// Tampilkan hasil
echo "Total: " . $total;
๐ก 4. Kenapa Komentar Itu Penting?
Tanpa komentar, kode kamu bisa jadi membingungkan — bahkan oleh dirimu sendiri di kemudian hari!
Bayangkan ini:
$a = $b * $c;
Lebih baik begini:
// Menghitung total harga berdasarkan jumlah
$total_harga = $harga * $jumlah;
๐งช Studi Kasus Mini:
<?php
// Menentukan status berdasarkan usia
$usia = 18;
if ($usia >= 17) {
echo "Dewasa";
} else {
echo "Anak-anak";
}
?>
โ Kesimpulan
Komentar adalah alat komunikasi di dalam kode. Gunakan dengan bijak untuk menjelaskan logika, bukan untuk menulis ulang kode yang sudah jelas. Dan jangan lupa: kode yang rapi = kode yang ramah developer.