Fondasi HTML

BAB 11: Komentar HTML

Cara menulis komentar di HTML, kegunaannya untuk dokumentasi dan debugging, serta batasan yang perlu dipahami.

Dari semua yang sudah kamu tulis di bio.html (heading, paragraf, kutipan, atribut style) semuanya akhirnya ditampilkan di browser. Tapi ada satu konstruksi dalam HTML yang sengaja dirancang untuk tidak tampil: komentar.

Komentar bukan fitur tambahan yang jarang dipakai. Dalam proyek nyata, komentar adalah bagian dari kebiasaan kerja yang baik: cara menandai bagian kode yang sedang diuji coba, menyisipkan catatan untuk anggota tim, atau menonaktifkan sementara elemen yang tidak ingin dihapus permanen.

Sintaks Dasar Komentar

Komentar HTML dibuka dengan <!-- dan ditutup dengan -->. Semua yang ada di antara kedua penanda ini diabaikan sepenuhnya oleh browser dan tidak akan pernah muncul di halaman.

HTMLHTML
<!-- belajar-html/index.html -->
<!DOCTYPE html>
<html lang="id">
<head>
  <meta charset="UTF-8">
  <title>Belajar HTML</title>
</head>
<body>

  <!-- Bagian utama halaman -->
  <h1>Selamat datang</h1>

  <!-- TODO: tambahkan foto profil setelah foto tersedia -->
  <p>Ini adalah halaman HTML pertama saya.</p>

</body>
</html>

Satu hal yang sering membingungkan pemula: tanda seru (!) hanya ada di tag pembuka <!--, tidak di tag penutup -->. Ini memang asimetris, tapi itulah spesifikasi HTML yang sudah berjalan selama puluhan tahun.

Komentar untuk Dokumentasi

Komentar paling sering dipakai untuk menjelaskan struktur halaman, terutama ketika markup sudah cukup panjang dan bagian-bagiannya tidak langsung jelas hanya dari membaca tag.

HTMLHTML
<!-- belajar-html/index.html (dikembangkan dari Bab 10) -->
<!DOCTYPE html>
<html lang="id">
<head>
  <meta charset="UTF-8">
  <title>Belajar HTML</title>
</head>
<body>

  <!-- ===================== HEADER ===================== -->
  <header>
    <h1>Selamat datang</h1>
    <p>Halaman belajar HTML</p>
  </header>

  <!-- ===================== PROFIL ===================== -->
  <section id="profil">
    <h2>Tentang Saya</h2>
    <p>
      Saya seorang web developer yang sedang membangun fondasi HTML
      dari struktur paling dasar.
    </p>
  </section>

  <!-- ===================== KEAHLIAN ===================== -->
  <section id="keahlian">
    <h2>Keahlian</h2>
    <ul>
      <li>HTML &amp; CSS</li>
      <li>JavaScript</li>
    </ul>
  </section>

  <!-- ===================== FOOTER ===================== -->
  <footer>
    <address>
      Hubungi saya via
      <a href="mailto:[email protected]">[email protected]</a>.
    </address>
  </footer>

</body>
</html>

Komentar separator seperti <!-- ===== HEADER ===== --> ini sangat umum di file HTML yang panjang. Saat kamu harus menemukan bagian footer di file 300 baris, komentar seperti ini jauh lebih cepat dibaca daripada menelusuri tag satu per satu.

Menonaktifkan Elemen Sementara

Salah satu kegunaan komentar yang sangat praktis adalah "mematikan" bagian HTML tanpa menghapusnya. Ini berguna saat kamu sedang menguji coba desain atau ingin membandingkan dua versi tampilan.

HTMLHTML
<!-- belajar-html/index.html -->
<section id="keahlian">
  <h2>Keahlian</h2>

  <!-- Versi daftar, sedang diuji coba -->
  <!--
  <ul>
    <li>HTML &amp; CSS</li>
    <li>JavaScript</li>
  </ul>
  -->

  <!-- Versi tabel, aktif saat ini -->
  <table>
    <tr>
      <th>Teknologi</th>
      <th>Level</th>
    </tr>
    <tr>
      <td>HTML &amp; CSS</td>
      <td>Mahir</td>
    </tr>
    <tr>
      <td>JavaScript</td>
      <td>Menengah</td>
    </tr>
  </table>
</section>

Dengan cara ini, versi daftar tetap ada di file dan bisa diaktifkan kembali kapan saja hanya dengan menghapus <!-- dan --> yang mengapitnya. Jauh lebih aman daripada menghapus dan mengetik ulang dari awal.

Hampir semua editor kode punya shortcut untuk komentar. Di VS Code, tekan Ctrl+/ (atau Cmd+/ di Mac) untuk memberi komentar pada baris yang dipilih. Untuk komentar blok HTML, gunakan Shift+Alt+A.

Komentar Inline

Komentar tidak harus berdiri sendiri di baris terpisah. Kamu bisa menyisipkan komentar di dalam baris elemen untuk catatan singkat yang konteksnya sangat spesifik.

HTMLHTML
<!-- belajar-html/index.html -->
<ul>
  <li>HTML &amp; CSS</li>
  <li>JavaScript <!-- ES2022+ --></li>
  <li>TypeScript <!-- superset JavaScript dengan type checking --></li>
</ul>

Komentar inline berguna untuk catatan teknis yang terlalu detail jika dijadikan komentar blok penuh, tapi terlalu penting untuk dibiarkan tanpa penjelasan.

Batasan yang Perlu Dipahami

Ada satu batasan penting: komentar HTML tidak bisa bersarang.

HTMLHTML
<!-- belajar-html/index.html -->
<!-- JANGAN lakukan ini -->
<!--
  <p>Paragraf pertama</p>
  <!-- ini komentar di dalam komentar - tidak valid -->
  <p>Paragraf kedua</p>
-->

Saat browser menemukan --> pertama (yang menutup komentar dalam), ia menganggap komentar sudah selesai. Teks setelahnya (termasuk <p>Paragraf kedua</p>) akan dirender sebagai HTML biasa, bukan komentar. Ini sumber bug yang tidak langsung terlihat.

Jangan gunakan -- di dalam teks komentar. Menurut spesifikasi HTML, -- hanya boleh muncul sebagai bagian dari penanda pembuka <!-- dan penutup -->. Browser modern umumnya toleran, tapi ini tetap markup yang tidak valid.

Satu hal lagi yang perlu dipahami: komentar HTML tidak menyembunyikan data dari pengguna. Siapapun bisa menekan Ctrl+U di browser dan membaca semua komentar di source code. Jangan simpan informasi sensitif (token API, catatan internal, atau hal yang tidak untuk publik) di dalam komentar HTML.

Latihan

Buka bio.html yang sudah dikembangkan sejak Bab 3 dan terapkan komentar secara bermakna:

  1. Tambahkan komentar separator untuk setiap section besar (header, tiap section, footer). Gunakan format yang konsisten (misalnya garis pembatas ===) agar mudah dibaca sekilas.

  2. Di section keahlian, buat dua versi tampilan (daftar biasa vs tabel). Nonaktifkan satu versi menggunakan komentar dan biarkan yang lain aktif. Buka di browser untuk memastikan hanya satu yang ditampilkan.

  3. Tambahkan setidaknya dua komentar inline pada elemen yang menurutmu perlu catatan singkat, misalnya kenapa memilih atribut tertentu atau mengapa menggunakan elemen semantik tertentu.

Sekarang bio.html sudah terdokumentasi dengan baik. Langkah berikutnya membawa kita ke topik yang berbeda karakter: warna. HTML sendiri punya cara lama untuk mendefinisikan warna lewat atribut, tapi cara modern mengaturnya lewat CSS, dan dua pendekatan ini punya implikasi berbeda pada pemeliharaan kode jangka panjang.

Kode lengkap bab ini tersedia di repositori abdasis/html-dasar di folder html-dasar/bab-11-komentar/.

Referensi

  1. 1 MDN Web Docs: HTML comments
  2. 2 MDN Web Docs: Comments in HTML
  3. 3 Debugging HTML: MDN Web Docs