Penulisan Komentar pada Bahasa Java

Pada kesempatan kali ini kita akan membahas tentang komentar pada Java. Komentar ini penting untuk diketahui karena dapat berfungsi sebagai penjelas kode yang kita buat.

Java memiliki beberapa jenis komentar, yaitu:

• Komentar satu baris (single line comment)
• Komentar banyak baris (multiline comment)
• Komentar dokumentasi (doc comment)

Mari kita bahas lebih lanjut.

Tentang Komentar pada Bahasa Java

Komentar atau comments merupakan blok kode yang tidak akan dibaca dan tidak akan dieksekusi oleh komputer. Walau begitu, komentar ini memiliki fungsi yang penting.

Komentar berfungsi untuk membantu programmer mengerti maksud dari kode yang telah ditulis.

Ketika menulis program, pasti kita tahu betul apa maksud kode yang kita ketikkan. Tapi apa yang terjadi jika kode itu ditinggal selama sekian hari atau bahkan sekian tahun?

Karena programmer juga manusia, dan manusia tidak luput dari lupa, besar kemungkinan kita akan lupa maksud dari kode yang kita tulis. Apalagi jika kode yang ditulis semrawut dengan penamaan yang tidak jelas. Wahh... susah 😞.

Di sinilah pentingnya menulis komentar. Dengan komentar, kita bisa mendeskripsikan kode yang kita tulis dalam bahasa manusia yang tentu lebih manusiawi dari bahasa komputer.

Selain untuk itu, komentar juga dapat berfungsi sebagai sarana debugging kode. Kita dapat memerintahkan komputer untuk mengabaikan baris kode tanpa perlu menghapusnya.

Penulisan Komentar pada Bahasa Java

Kita bisa menempatkan komentar di mana saja sesuka kita. Dalam komentar juga dapat ditulis apa saja yang kita inginkan. Tidak harus kode program. Menulis puisi dalam comment juga tidak masalah.

Untuk menulis komentar, Java memiliki 3 sintaks yang berbeda, yaitu:

Komentar Satu Baris (Single Line Comments)

Seperti namanya, komentar ini hanya bisa ditulis dalam satu baris saja.

Penulisan komentar satu baris diawali dengan tanda //. Contoh:

// Ini adalah komentar satu baris
// Kode ini di luar blok kelas

public class HelloWorld {
  // Kode ini di dalam blok kelas HelloWorld
  public static void main(String args[]) {
    // Kode ini di dalam blok fungsi main
    System.out.println("Hello World!"); // Baris ini mencetak "Hello World"
  }
}

Jika kode tersebut dijalankan, pasti tidak akan ada perubahan dari sebelumnya. Ini karena komentar tidak dieksekusi oleh komputer.

Komentar Banyak Baris (Multi Line Comments)

Dengan multi line comments kita bisa menuliskan satu atau beberapa baris komentar dalam satu blok comment.

Aturan penulisannya adalah dibuka dengan /* dan ditutup dengan */. Contoh:

/* Ini adalah komentar banyak baris
Kode ini di luar blok kelas */

public class HelloWorld {
  /*
    Kode ini di dalam blok kelas HelloWorld
    ini baris komentar baru
    tetap dalam blok komentar yang sama
  */
  public static void main(String args[]) {
    /*
      Fungsi utama ini akan dipanggil pertama kali
      oleh komputer. Kode di bawah bertujuan untuk
      mencetak "Hello World" di layar konsol
    */
    System.out.println("Hello World!");
    /* multi line comment juga bisa digunakan untuk komentar satu baris */
  }
}

Komentar Dokumentasi (Doc Comments)

Yang terakhir ada komentar dokumentasi.

Komentar ini memiliki fungsi khusus untuk membuat dokumentasi kode yang kita buat. Java memiliki alat yang bernama JavaDoc untuk membuat dokumentasi dari komentar.

Doc comments memiliki sintaks seperti multi line comments, hanya yang membedakan adalah pembukanya yaitu /** dan setiap baris komentar harus diawali tanda *. Contohnya:

/**
* Kelas utama program "Hello World"
* @author Inva
*/
public class HelloWorld {
  /**
  * Fungsi utama yang akan dipanggil oleh komputer
  * Berfungsi untuk mencetak <code>Hello World<code> di layar konsol
  * @params tidak ada parameter yang idpakai
  * @return tidak mengembalikan apa-apa
  */
  public static void main(String args[]) {
    System.out.println("Hello World!");
  }
}

Penulisan komentar jenis ini tidak boleh sembarangan, ada spesifikasi tersendiri dari JavaDoc. Untuk lebih lanjut bisa di lihat di laman panduan JavaDoc.

Karena fungsinya yang spesifik, kita tidak akan menggunakan komentar dokumentasi dalam Seri Belajar Java ini.

Selanjutnya

Komentar memang tidak berguna di mata komputer, tetapi sangat membantu programmer membaca programnya. Jadi jangan sungkan untuk menulis komentar.

Pada kesempatan-kesempatan selanjutnya kita akan sering melihat komentar menyelingi kode yang kita buat, jadi jangan sampai bingung ya. Itu hanya penjelas, tidak ditulis pun tidak apa-apa.

Selanjutnya kita akan membahas tentang sistem output pada bahasa Java.

Selamat berkoding ria 👋