Komentar adalah catatan yang ditulis di dalam kode tetapi diabaikan sepenuhnya oleh interpreter PHP — Anda bebas menulis apa pun di dalamnya tanpa memengaruhi jalannya program. Kegunaannya nyata: menjelaskan alasan di balik keputusan kode, menonaktifkan sementara sebuah baris saat mencari kesalahan, sampai menjadi dokumentasi resmi yang dibaca oleh editor dan alat analisis. Pada Chapter ini kita pelajari tiga gaya komentar PHP, konvensi doc comment yang dipakai industri, serta kebiasaan memilah kapan berkomentar itu membantu dan kapan justru menyesatkan.

Tiga Gaya Komentar #

PHP mewarisi gaya komentar dari dua bahasa leluhurnya: // dan /* ... */ dari C, serta # dari script shell. Ketiganya sah dan bisa dipakai berdampingan:

php 
<?php

// Gaya satu baris dari C++ — paling umum dipakai sehari-hari
echo "Baris pertama\n";

echo "Baris kedua\n"; # gaya shell — sah, tetapi jarang dipakai di kode modern

/* Komentar gaya C, bisa mencakup satu baris penuh */
echo "Baris ketiga\n";

Output yang Dihasilkan:

text 
Baris pertama
Baris kedua
Baris ketiga

Komentar satu baris berlaku dari tanda pembuka hingga akhir baris — contoh # di atas memperlihatkannya: komentar menempel di akhir statement tanpa mengganggu eksekusinya, dan kode di baris berikutnya tetap berjalan normal. Perhatikan pula bahwa tidak satu pun komentar ikut tercetak; interpreter melompatinya begitu saja seolah teks itu tidak ada. Untuk konsistensi, kebanyakan proyek modern memilih satu gaya favorit (umumnya //) dan memakainya di seluruh codebase.

Komentar Multi-Baris #

Ketika catatan butuh beberapa baris — misalnya menjelaskan rumus atau mencatat asumsi — gunakan pasangan /* ... */. Semua yang berada di antara pembuka dan penutup diabaikan, termasuk pergantian baris di tengahnya:

php 
<?php

/*
 * Laporan penjualan harian.
 * Rumus: total = (harga satuan x jumlah) - diskon.
 * Diskon dianggap nilai tetap, bukan persentase.
 */
$hargaSatuan = 25000;
$jumlah = 2;
$diskon = 5000;

$total = ($hargaSatuan * $jumlah) - $diskon;
echo "Total bayar: Rp$total\n";

Output yang Dihasilkan:

text 
Total bayar: Rp45000

Blok /* ... */ di atas juga memperlihatkan kebiasaan penulisan yang umum: tanda * di awal tiap baris dalam blok menjorok sejajar, membuat komentar terlihat seperti kotak rapi. Satu batasan penting: komentar gaya ini tidak bisa bersarang. Begitu PHP bertemu */ pertama, komentar dianggap selesai — sisa */ dari “komentar dalam” yang Anda niatkan akan menjadi kode nyata dan memicu parse error. Sebagai gantinya, tulis // di setiap baris bila butuh komentar dalam komentar.

Satu kegunaan praktis komentar yang akan sering Anda lakukan: menonaktifkan satu baris kode sementara tanpa menghapusnya. Programmer menyebut kebiasaan ini comment out, dan kebalikannya uncomment:

php 
<?php

$stokGudang = 40;
$stokToko = 12;

// echo "Stok gudang: $stokGudang\n";  <- baris ini sengaja dinonaktifkan
echo "Total stok: " . ($stokGudang + $stokToko) . "\n";

Output yang Dihasilkan:

text 
Total stok: 52

Baris echo yang dikomentari sama sekali tidak dieksekusi — output hanya berisi total stok. Saat mencari kesalahan, teknik ini memungkinkan Anda mengisolasi baris yang dicurigai tanpa kehilangan kodenya.

Doc Comment untuk Dokumentasi #

Ada satu varian khusus yang dibedakan oleh dua tanda bintang pembuka: /** ... */. Bentuk ini, disebut doc comment, adalah konvensi untuk mendokumentasikan function dan class. Isinya mengikuti format PHPDoc — ringkasan singkat di atas, lalu baris berawalan @param dan @return yang memetakan parameter serta nilai kembali:

php 
<?php

/**
 * Menghitung total belanja setelah diskon.
 *
 * @param int $hargaSatuan Harga per unit dalam Rupiah
 * @param int $jumlah      Banyaknya unit yang dibeli
 * @param int $diskon      Potongan harga dalam Rupiah
 *
 * @return int Total yang harus dibayar
 */
function hitungTotal($hargaSatuan, $jumlah, $diskon)
{
    return ($hargaSatuan * $jumlah) - $diskon;
}

echo "Total belanja: Rp" . hitungTotal(25000, 2, 5000) . "\n";

Output yang Dihasilkan:

text 
Total belanja: Rp45000

Jangan terjebak belum mengenal syntax function — materi lengkapnya menunggu di Section Fungsi. Fokus kita adalah blok /** ... */ di atasnya: bagi interpreter, doc comment hanyalah komentar biasa yang diabaikan; bagi editor dan alat analisis statis seperti PHPStan, blok itu adalah data berharga yang dipakai untuk menampilkan petunjuk parameter dan memeriksa kesalahan tipe. Menulis doc comment yang rapi sejak proyek kecil adalah investasi yang terbayar saat codebase membesar.

Komentar PHP dan Komentar HTML #

Pada berkas template yang bercampur HTML, Anda punya dua pilihan komentar — dan keduanya sangat berbeda nasibnya:

php 
<?php $pesan = "Diskon 20% khusus hari ini"; ?>
<!-- Komentar HTML: ikut terkirim ke browser pengguna -->
<p><?= $pesan ?></p>
<?php /* Komentar PHP: berhenti di server, tak pernah terlihat browser */ ?>

Output yang Dihasilkan:

text 
<!-- Komentar HTML: ikut terkirim ke browser pengguna -->
<p>Diskon 20% khusus hari ini</p>

Output memperlihatkan kebenarannya: komentar HTML tetap ada karena ia bagian dari zona teks yang dikirim apa adanya, sedangkan komentar PHP lenyap tanpa jejak. Implikasi keamanannya penting diingat sejak dini — jangan pernah menaruh catatan rahasia pada komentar HTML, karena siapa pun yang membuka fitur view source di browser dapat membacanya. Komentar PHP satu-satunya tempat yang benar-benar private.

Ringkasan #

PHP menyediakan komentar satu baris (// dan #), blok multi-baris (/* ... */), serta doc comment (/** ... */) yang menjadi dokumen resmi function dan class. Komentar menjelaskan alasan di balik kode, menonaktifkan baris saat mencari kesalahan, dan — pada template — memberi ruang catatan yang tidak pernah terkirim ke browser. Setelah kode bisa dicatat, mari kita kembali ke output: cara kerja echo dan print secara utuh pada Chapter berikutnya.

Referensi #