Seni Menulis Komentar: Dokumentasi vs Polusi Kode
Komentar dala m HTML ditulis dengan sintaks ``. Segala sesuatu di dalam tanda tersebut tidak akan diproses oleh browser dan tidak akan muncul di layar pengguna. Namun, komentar tetap bisa dilihat oleh siapa saja melalui fitur "View Page Source".
A. Kapan Harus Menulis Komentar?
Komentar sangat berguna dalam situasi berikut:
-
Menandai Awal dan Akhir Blok Kode Besar: Terutama pada halaman yang memiliki banyak elemen
bersarang (nested).< !---->HTML<header> ... header> -
Menjelaskan Logika yang Tidak Biasa: Jika Anda menggunakan trik khusus atau workaround untuk browser tertentu, berikan catatan mengapa hal itu dilakukan.
-
Dokumentasi Tim: Membantu rekan kerja (atau diri Anda di masa depan) memahami maksud dari struktur HTML tertentu, terutama pada template yang kompleks.
-
Menandai Slot Dinamis (Backend): Sangat berguna bagi developer Laravel untuk menandai di mana data dinamis akan disuntikkan.
HTML<div id="news-container">div>
B. Kapan Harus Menghapus Komentar?
Komentar bisa menjadi beban jika tidak dikelola dengan benar, terutama saat website sudah siap diluncurkan (Production).
-
Komentar "Kode Mati": Menghapus blok kode lama dengan cara menjadikannya komentar (biasanya disebut "commented out code") adalah kebiasaan buruk. Gunakan Version Control (Git) untuk menyimpan sejarah kode, jangan biarkan kode mati menumpuk di file HTML.
-
Informasi Sensitif: Jangan pernah menulis detail login, alamat API internal, atau catatan pribadi di dalam kom entar HTML. Ingat, Source Code HTML bersifat publik.
-
Proses Deployment (Minifikasi): Saat melakukan deployment, sangat disarankan untuk menggunakan alat minifier yang secara otomatis menghapus semua komentar untuk memperkecil ukuran file dan mempercepat waktu muat halaman.
-
Komentar yang Terlalu Jelas: Hindari menulis komentar untuk hal-hal yang sudah jelas.
-
Buruk:
-
Baik: (Tanpa komentar karena tag
-
Tutorial: Struktur Komentar yang Profesional
Mari kita terapkan standar komentar yang bersih pada sebuah layout halaman berita.
html>
<html lang="id">
<head> <meta charset="UTF-8"> <title>Portal Berita Barutitle>
head>
<body> <nav> <ul> <li><a href="#">Berandaa>li> ul> nav> <main> <section id="latest-news"> section> main> <footer> <p>© 2026 Portal Berita.p> footer> <script src="analytics.js">script> body>
html>
Tabel Ringkasan Etika Komentar
| Jenis Komentar | Status | Alasan |
| Penanda Struktur | Disarankan | Mempermudah navigasi kode yang panjang. |
| Catatan Logika/Fix | Disarankan | Menjelaskan "mengapa" kode itu ada di sana. |
| Kode Lama (Unused) | Hapus | Mengotori file; gunakan Git sebagai gantinya. |
| Data Sensitif/Internal | DILARANG | Risiko keamanan; bisa dilihat publik via "View Source". |
Kesimpulan
Komentar adalah alat komunikasi antar developer. Gunakanlah untuk memperjelas maksud Anda, bukan untuk menyembunyikan kode yang berantakan. Kode yang ditulis dengan baik seringkali sudah cukup menjelaskan dirinya sendiri tanpa perlu terlalu banyak komentar.
