Komentar Dart

Komentar Dart 💬

Komentar adalah teks di dalam kode yang tidak dieksekusi oleh program. Dart mendukung tiga jenis komentar dengan fungsi yang berbeda-beda.

1. Komentar Satu Baris (//)

Paling umum digunakan, ditulis dengan dua garis miring //:

// Ini komentar satu baris
void main() {
  int umur = 25; // umur pengguna dalam tahun
  print(umur);   // menampilkan nilai umur
}

2. Komentar Multi-Baris (/* */)

Digunakan untuk komentar yang lebih panjang dari satu baris:

/*
  Fungsi ini menghitung luas persegi panjang.
  Menerima dua parameter: panjang dan lebar.
  Mengembalikan hasil luas dalam bentuk double.
*/
double hitungLuas(double panjang, double lebar) {
  return panjang * lebar;
}

3. Komentar Dokumentasi (///)

Komentar dokumentasi diawali dengan tiga garis miring /// dan digunakan untuk mendokumentasikan kelas, fungsi, atau variabel secara resmi. Komentar ini dibaca oleh tool seperti dart doc untuk menghasilkan dokumentasi HTML:

/// Menghitung luas lingkaran berdasarkan jari-jari.
///
/// Parameter [r] adalah jari-jari lingkaran dalam satuan meter.
/// Mengembalikan luas dalam satuan meter persegi.
double luasLingkaran(double r) {
  return 3.14159 * r * r;
}

/// Kelas yang merepresentasikan seorang pengguna.
class Pengguna {
  /// Nama lengkap pengguna.
  String nama;

  /// Usia pengguna dalam tahun.
  int usia;

  Pengguna(this.nama, this.usia);
}

Fungsi Komentar dalam Praktik

Menjelaskan Logika yang Kompleks:

void main() {
  // Cek prima: bilangan habis dibagi hanya oleh 1 dan dirinya sendiri
  int angka = 17;
  bool prima = true;

  for (int i = 2; i < angka; i++) {
    if (angka % i == 0) {
      prima = false;
      break;
    }
  }

  print('$angka adalah prima: $prima');
}

Menonaktifkan Kode Sementara:

void main() {
  int x = 10;
  int y = 20;

  // print('Debug: x = $x, y = $y');

  int total = x + y;
  print('Total: $total');
}

Menandai Pekerjaan yang Belum Selesai:

void prosesData() {
  // TODO: implementasi validasi data
  // FIXME: ada bug saat input kosong
  print('Memproses data...');
}

Perbedaan Tiga Jenis Komentar

💡 Tips: Komentar yang baik menjelaskan mengapa sesuatu dilakukan, bukan apa yang dilakukan — karena kode yang baik sudah menjelaskan dirinya sendiri. Gunakan /// untuk semua fungsi dan kelas publik agar dokumentasi otomatis bisa di-generate dengan perintah dart doc. 📚