Pada materi ini kita masuk ke topik Comments (komentar) dalam Dart. Konsepnya sebenarnya sederhana, tetapi sangat penting karena komentar akan sering digunakan ketika membuat program yang lebih besar.

Ada sedikit kesalahan penyebutan di caption: beberapa kali disebut “do programming language”, kemungkinan maksudnya adalah Dart programming language.

1. Apa itu Comment dalam Dart?

Comment (komentar) adalah tulisan di dalam kode yang tidak dijalankan oleh program.

Artinya, Dart akan melihat komentar sebagai sesuatu yang hanya ditujukan untuk manusia, bukan untuk dieksekusi.

Misalnya:

void main() {
  // Ini adalah nama pengguna
  String name = 'Ahad';

  print(name);
}

Ketika program dijalankan, yang muncul hanya:

Ahad

Tulisan:

// Ini adalah nama pengguna

tidak akan muncul dan tidak akan dijalankan.

Gampangnya, bayangkan seperti ini:

Kamu sedang membaca sebuah buku.

Di samping paragraf utama, kamu menulis catatan:

“Bagian ini penting.”

Catatan tersebut bukan bagian dari isi cerita. Catatan itu hanya membantu kamu memahami isi buku.

Comment dalam pemrograman juga seperti itu.

Kode = isi program Comment = catatan untuk programmer

2. Mengapa kita menggunakan Comment?

Comment sangat berguna untuk beberapa hal.

① Menjelaskan kode

Misalnya kita punya:

int price = 50000;

Orang lain mungkin bertanya:

“Angka 50000 ini untuk apa?”

Kita bisa memberikan komentar:

// Harga produk dalam rupiah
int price = 50000;

Sekarang lebih jelas.

② Membantu kita memahami kode sendiri

Bayangkan kamu membuat program hari ini.

Kemudian enam bulan kemudian kamu membuka kode tersebut.

Kalau programnya sudah panjang, kamu mungkin lupa:

“Ini kode buat apa ya?”

Komentar bisa membantu mengingat maksud kode tersebut.

③ Membantu programmer lain

Dalam proyek nyata, biasanya kode tidak dibuat sendirian.

Misalnya ada 5 programmer yang mengerjakan satu aplikasi.

Kamu membuat:

// Menghitung total harga setelah diskon
double total = price - discount;

Programmer lain akan lebih mudah memahami maksud kode tersebut.

④ Menonaktifkan kode sementara

Ini juga sangat sering dilakukan.

Misalnya kita punya:

void main() {
  print('Hello');
  print('Dart');
  print('Programming');
}

Untuk sementara kita tidak ingin menjalankan:

print('Dart');

Kita bisa membuatnya menjadi komentar:

void main() {
  print('Hello');

  // print('Dart');

  print('Programming');
}

Hasil:

Hello
Programming

Jadi comment juga bisa digunakan untuk sementara menonaktifkan kode tanpa harus menghapusnya.

3. Jenis Comment dalam Dart

Pada materi ini disebutkan ada 3 jenis comment:

1. Single-line comment
2. Multi-line comment
3. Documentation comment

Mari kita bahas satu per satu.

4. Single-Line Comment

Single-line comment adalah komentar yang hanya berlaku untuk satu baris.

Penulisannya menggunakan:

//

Contoh:

void main() {
  // Ini adalah nama pengguna
  String name = 'Ahad';

  print(name);
}

Komentarnya adalah:

// Ini adalah nama pengguna

Dart akan mengabaikan tulisan tersebut.

Comment bisa ditulis setelah kode

Tidak harus selalu berada di baris sendiri.

Contohnya:

int age = 20; // umur pengguna

Di sini:

int age = 20;

adalah kode program.

Sedangkan:

// umur pengguna

adalah komentar.

Program tetap menjalankan:

int age = 20;

dan mengabaikan:

// umur pengguna

5. Kenapa menggunakan dua garis miring //?

Dalam Dart:

//

berarti:

“Mulai dari sini sampai akhir baris adalah komentar.”

Contohnya:

// Hello

atau:

// Ini adalah komentar

atau:

print('Hello'); // Menampilkan Hello

Setelah //, Dart tidak menganggap tulisan tersebut sebagai instruksi program.

6. Contoh Single-Line Comment

Misalnya kita mempunyai program:

void main() {
  String name = 'Ahad';
  int age = 20;
  int score = 90;

  print(name);
  print(age);
  print(score);
}

Kita bisa memberikan komentar:

void main() {
  // Menyimpan nama pengguna
  String name = 'Ahad';

  // Menyimpan umur pengguna
  int age = 20;

  // Menyimpan nilai pengguna
  int score = 90;

  print(name);
  print(age);
  print(score);
}

Program tetap menghasilkan:

Ahad
20
90

Komentar tidak memengaruhi hasil program.

7. Multi-Line Comment

Sekarang bagaimana kalau kita ingin membuat komentar yang terdiri dari beberapa baris?

Kita bisa menggunakan multi-line comment.

Formatnya:

/*
   komentar
   komentar
   komentar
*/

Perhatikan:

Awalnya:

/*

dan akhirnya:

*/

Semua yang berada di antara keduanya dianggap sebagai komentar.

Contoh

void main() {
  /*
    Ini adalah komentar
    yang terdiri dari
    beberapa baris.
  */

  print('Hello Dart');
}

Hasil:

Hello Dart

Komentar tidak dijalankan.

8. Contoh Multi-Line untuk Menonaktifkan Banyak Kode

Ini salah satu kegunaan yang sangat praktis.

Misalnya kita mempunyai:

void main() {
  print('A');
  print('B');
  print('C');
  print('D');
}

Kita ingin sementara menonaktifkan B, C, dan D.

Bisa:

void main() {
  print('A');

  /*
  print('B');
  print('C');
  print('D');
  */
}

Hasil:

A

Karena ketiga print() tersebut berada di dalam comment.

9. Perbedaan Single-Line dan Multi-Line

Perhatikan perbandingan berikut.

Single-line

// Ini komentar satu baris

Hanya satu baris yang dikomentari.

Multi-line

/*
Ini komentar
yang terdiri
dari banyak baris
*/

Bisa digunakan untuk beberapa baris sekaligus.

Cara mudah mengingat

10. Documentation Comment

Jenis ketiga adalah documentation comment.

Syntax-nya:

///

Jadi bedanya dengan single-line comment adalah jumlah /.

Single-line:

//

Documentation:

///

Contoh:

/// Fungsi ini digunakan untuk mencetak nama pengguna.
void printName(String name) {
  print(name);
}

Komentar tersebut menjelaskan fungsi yang berada di bawahnya.

11. Apa bedanya // dengan ///?

Untuk pemula, cara paling mudah memahaminya:

//

Biasanya digunakan sebagai catatan biasa untuk programmer.

// Menyimpan nama pengguna
String name = 'Ahad';

///

Biasanya digunakan untuk dokumentasi, terutama pada class, function, method, property, dan API yang ingin dijelaskan kepada pengguna kode.

Contoh:

/// Menghitung luas persegi panjang.
double calculateArea(double length, double width) {
  return length * width;
}

Jadi /// lebih cocok untuk menjelaskan:

“Fungsi ini sebenarnya digunakan untuk apa?”

12. Kenapa Documentation Comment berguna?

Bayangkan kamu membuat sebuah fungsi:

double calculateArea(double length, double width) {
  return length * width;
}

Orang yang melihatnya mungkin harus membaca seluruh kode untuk memahami fungsi tersebut.

Dengan documentation comment:

/// Menghitung luas persegi panjang.
double calculateArea(double length, double width) {
  return length * width;
}

Tujuannya menjadi lebih jelas.

Dalam proyek Dart yang besar, dokumentasi seperti ini sangat membantu.

13. Shortcut Comment di VS Code

Caption juga menunjukkan cara cepat membuat komentar menggunakan VS Code.

Misalnya kamu punya:

print('Hello');

Kemudian kamu memilih baris tersebut dan menggunakan shortcut:

Ctrl + /

VS Code biasanya akan mengubahnya menjadi:

// print('Hello');

Jadi kode tersebut sekarang menjadi komentar.

Kalau shortcut digunakan lagi, komentarnya bisa dihapus/toggle kembali menjadi kode.

14. Contoh Lengkap Ketiga Jenis Comment

Sekarang kita gabungkan semuanya.

void main() {
  // Single-line comment
  String name = 'Ahad';

  /*
    Multi-line comment.
    Komentar ini terdiri
    dari beberapa baris.
  */

  /// Documentation comment
  int age = 20;

  print(name);
  print(age);
}

Program tetap menjalankan:

String name = 'Ahad';
int age = 20;

print(name);
print(age);

Komentar hanya digunakan sebagai informasi bagi programmer.

15. Comment Tidak Sama dengan String

Ini penting untuk dipahami.

Misalnya:

print('Hello');

'Hello' adalah String dan akan diproses oleh program.

Sedangkan:

// Hello

adalah comment dan tidak diproses sebagai kode.

Perhatikan:

void main() {
  print('Hello');
  // Hello
}

Hasil:

Hello

Hello yang ada di dalam print() ditampilkan.

Sedangkan Hello yang berada setelah // tidak ditampilkan.

16. Kesalahan yang Sering Dilakukan Pemula

Kesalahan 1 — Lupa //

Misalnya:

void main() {
  Ini adalah komentar
  print('Hello');
}

Ini bukan komentar.

Dart akan menganggap:

Ini adalah komentar

sebagai kode, sehingga muncul error.

Harus:

void main() {
  // Ini adalah komentar
  print('Hello');
}

Kesalahan 2 — Salah menutup multi-line comment

Misalnya:

/*
Ini komentar

Kita lupa menutupnya dengan:

*/

Seharusnya:

/*
Ini komentar
*/

Kesalahan 3 — Mengira komentar dijalankan

Misalnya:

// print('Hello');

Pemula mungkin mengira Hello akan muncul.

Tidak.

Karena seluruh baris tersebut adalah komentar.

17. Comment Tidak Membuat Program Lebih Lambat Saat Runtime

Secara konsep, comment bukan instruksi yang dijalankan oleh program.

Misalnya:

void main() {
  // Ini komentar
  // Ini juga komentar
  // Komentar lagi
  print('Hello');
}

Komentar tersebut tidak menjadi operasi yang dilakukan program seperti print(), perhitungan, dan sebagainya.

Jadi kita tidak perlu takut menggunakan komentar untuk membuat kode lebih mudah dipahami.

18. Jangan Berlebihan Menggunakan Comment

Meskipun comment berguna, bukan berarti setiap baris harus diberi komentar.

Contoh yang kurang berguna:

// Membuat variabel name
String name = 'Ahad';

Komentar tersebut sebenarnya tidak memberikan informasi baru karena kode sudah sangat jelas.

Lebih baik komentar menjelaskan alasan atau tujuan.

Contoh:

// Menggunakan nama default jika pengguna belum memasukkan nama.
String name = 'Guest';

Ini lebih berguna.

Prinsip sederhana:

Jangan hanya menjelaskan “apa” yang dilakukan kode. Jika memungkinkan, jelaskan “mengapa” kode tersebut dibuat seperti itu.

19. Contoh dalam Program yang Lebih Realistis

Misalnya kita membuat program menghitung total belanja:

void main() {
  // Harga barang
  double price = 100000;

  // Diskon 10%
  double discount = 0.10;

  // Menghitung jumlah diskon
  double discountAmount = price * discount;

  // Harga setelah diskon
  double total = price - discountAmount;

  print(total);
}

Komentar membantu kita membaca program seperti cerita:

1. Ada harga barang.
2. Ada diskon 10%.
3. Hitung jumlah diskon.
4. Kurangi harga dengan diskon.
5. Tampilkan total.

Tanpa mengubah cara program bekerja.

20. Cara Mengingat Ketiga Jenis Comment

Cukup ingat pola berikut:

//      → komentar satu baris

/* */   → komentar banyak baris

///     → dokumentasi

Atau:

2 garis miring = komentar biasa /* */ = komentar blok 3 garis miring = dokumentasi

21. Ringkasan Materi

Contoh:

void main() {
  // Single-line comment

  /*
    Multi-line comment
  */

  /// Documentation comment
  print('Hello Dart');
}

Yang dijalankan hanya:

print('Hello Dart');

Komentar tidak dieksekusi.

22. Inti yang Harus Kamu Pahami

Kalau ingin mengambil inti paling penting dari materi ini, ingat 5 hal:

1. Comment adalah catatan dalam kode

Comment dibuat untuk membantu manusia memahami program.

2. Comment tidak dieksekusi

// print('Hello');

tidak akan mencetak Hello.

3. // untuk satu baris

// Nama pengguna

4. /* */ untuk banyak baris

/*
  Baris pertama
  Baris kedua
  Baris ketiga
*/

5. /// untuk documentation comment

/// Menghitung luas lingkaran.
double calculateArea() {
  // ...
}

🧠 Analogi paling gampang

Bayangkan kode Dart adalah resep memasak.

int temperature = 180;

adalah instruksi yang harus dilakukan.

Sedangkan:

// Gunakan suhu 180 derajat agar kue tidak cepat gosong

adalah catatan dari koki.

Catatan itu tidak membuat oven melakukan sesuatu. Catatan hanya membantu orang yang membaca resep memahami mengapa atau apa maksudnya.

Begitu juga dengan comment dalam Dart.

Kode → untuk komputer menjalankan program. Comment → untuk manusia memahami program.