Komentar dalam HTML

Komentar adalah bagian dari kode HTML yang tidak ditampilkan di browser saat halaman web di-render. Komentar digunakan untuk memberikan catatan, penjelasan, atau instruksi kepada pengembang yang membaca kode sumber HTML.

Sintaks Komentar

Komentar dalam HTML ditulis dengan sintaks berikut:

<!-- Ini adalah contoh komentar -->

Komentar diawali dengan <!-- dan diakhiri dengan -->. Teks di antara kedua simbol tersebut tidak akan diproses atau ditampilkan di browser.

Fungsi dan Penggunaan

1. Dokumentasi Kode
   • Memberikan penjelasan tentang tujuan atau fungsi bagian kode tertentu.
     Contoh:
     <!-- Bagian header untuk navigasi utama -->
<header>...</header>
2. Debugging
   • Menonaktifkan sementara bagian kode tanpa menghapusnya.
     Contoh:
     <!--
<div class="experimental-feature">
Konten yang sedang diuji
</div>
-->
3. Catatan untuk Kolaborasi
   • Memudahkan kerja tim dengan memberikan instruksi atau pengingat.
     Contoh:
     <!-- TODO: Tambahkan formulir kontak di sini -->
4. Menyembunyikan Kode Sementara
   • Berguna saat mengembangkan fitur yang belum selesai.

Contoh Komentar Multi-Baris

Komentar bisa mencakup beberapa baris:

<!-- 
  Ini adalah komentar panjang yang  
  menjelaskan struktur bagian footer. 
  Dibuat oleh: Tim Pengembang Web 
  Tanggal: 1 Januari 2024
-->
<footer>...</footer>

Best Practices

1. Hindari Komentar yang Tidak Perlu
   • Jangan menulis komentar untuk menjelaskan kode yang sudah jelas.
     Contoh buruk:
     <!-- Ini adalah paragraf -->
<p>Selamat datang</p>
2. Gunakan Bahasa yang Jelas
   • Pastikan komentar mudah dipahami oleh orang lain atau diri sendiri di masa depan.
3. Update Komentar
   • Jika kode diubah, pastikan komentar terkait juga diperbarui agar tidak menyesatkan.
4. Jangan Simpan Informasi Sensitif
   • Komentar tetap terlihat di kode sumber (view page source), jadi hindari menyimpan kata sandi atau informasi rahasia.

Catatan Penting

• Komentar tidak mendukung sintaks HTML atau CSS di dalamnya.
• Beberapa alat build (seperti minifiers) mungkin menghapus komentar saat produksi untuk mengoptimalkan ukuran file.

Dengan memahami penggunaan komentar, pengembang dapat menulis kode yang lebih terstruktur, mudah dipelihara, dan kolaboratif.

Sumber : DeepSeek