Komentar JavaScript

Komentar JavaScript 💬

Komentar adalah teks dalam kode yang diabaikan oleh JavaScript saat dieksekusi. Komentar digunakan untuk menjelaskan kode, menonaktifkan kode sementara, atau meninggalkan catatan penting.

Komentar Satu Baris

Menggunakan // — semua teks setelahnya hingga akhir baris diabaikan:

// Ini adalah komentar satu baris

let nama = 'Budi'; // komentar di akhir baris juga valid

// let umur = 25; — baris ini dinonaktifkan

Komentar Multi-Baris

Menggunakan /* */ — semua teks di antara tanda tersebut diabaikan:

/*
  Ini adalah komentar
  yang bisa mencakup
  beberapa baris sekaligus
*/

let harga = 50000;

/*
  Fungsi ini menghitung total harga
  dengan memperhitungkan diskon dan pajak
*/
function hitungTotal(harga, diskon) {
  return harga * (1 - diskon / 100);
}

JSDoc — Komentar Dokumentasi

Format standar untuk mendokumentasikan fungsi:

/**
 * Menghitung luas lingkaran berdasarkan jari-jari.
 * @param {number} jariJari - Jari-jari lingkaran dalam meter
 * @returns {number} Luas lingkaran dalam meter persegi
 */
function hitungLuasLingkaran(jariJari) {
  return Math.PI * jariJari * jariJari;
}

Editor seperti VS Code akan menampilkan komentar JSDoc sebagai tooltip saat kamu menggunakan fungsi tersebut.

Fungsi Komentar dalam Praktik

1. Menjelaskan Logika yang Tidak Jelas

// Kalikan dengan 1000 karena setTimeout menerima milisecond
setTimeout(kirimData, 5 * 1000);

// Mulai dari 1 karena indeks halaman di API ini berbasis 1
let halaman = 1;

2. Menonaktifkan Kode Sementara

function prosesData(data) {
  // console.log('Debug data:', data); // aktifkan saat debugging

  const hasil = data.map(item => item * 2);
  return hasil;
}

3. Menandai Pekerjaan yang Belum Selesai

function autentikasi(email, password) {
  // TODO: tambahkan validasi format email
  // FIXME: bug saat password mengandung karakter spesial
  // HACK: solusi sementara sampai API diperbaiki

  return fetch('/api/login', { method: 'POST' });
}

4. Memisahkan Bagian Kode

// ============================================
// KONFIGURASI
// ============================================
const BASE_URL = 'https://api.example.com';
const TIMEOUT = 5000;

// ============================================
// FUNGSI UTILITAS
// ============================================
function formatRupiah(angka) { /* ... */ }
function formatTanggal(tanggal) { /* ... */ }

// ============================================
// LOGIKA UTAMA
// ============================================
async function muatData() { /* ... */ }

Yang Tidak Perlu Dikomentar

Komentar yang hanya mengulang apa yang sudah jelas dari kode justru membuat file berantakan:

// ❌ Komentar yang tidak berguna
let i = 0; // menetapkan i ke 0
i++;        // menambah i sebesar 1

// ✅ Komentar berguna — menjelaskan MENGAPA, bukan APA
// Mulai dari 0 karena API mengembalikan indeks berbasis 0
let indeksAwal = 0;

Perbandingan Sintaks Komentar

💡 Tips: Komentar terbaik menjelaskan mengapa kode ditulis seperti itu — bukan apa yang dilakukan. Kode yang baik seharusnya sudah "menjelaskan dirinya sendiri" melalui penamaan yang jelas. Komentar diperlukan hanya untuk niat yang tidak terlihat dari kode, workaround bug, atau batasan yang tidak obvious. 🧑‍💻