Komentar Java: Tipe, Penggunaan, dan Best Practices
Komentar Java
Panduan ini menjelaskan komentar Java, mengapa penting, dan cara menggunakannya dengan benar untuk kode yang lebih jelas dan lebih mudah dipelihara.
// deklarasikan dan inisialisasi dua variabel int a = 1; int b = 3; // cetak output System.out.println("This is output");
Di sini kita menggunakan dua komentar: deklarasikan dan inisialisasi dua variabel dan cetak output.
Tipe Komentar di Java
Java mendukung dua gaya komentar utama:
- Komentar satu baris
- Komentar multi-baris
Komentar Satu Baris
Komentar satu baris dimulai dengan // dan berlanjut hingga akhir baris. Contoh:
// contoh program "Hello, World!" class Main { public static void main(String[] args) { // cetak "Hello, World!" System.out.println("Hello, World!"); } }
Output:
Hello, World!
Kita menggunakan dua komentar satu baris: "Hello, World!" program example dan prints "Hello, World!". Kompiler mengabaikan semua dari // hingga akhir baris.
Komentar Multi-Baris
Saat Anda membutuhkan beberapa baris, gunakan /* … */. Contoh:
/* Ini adalah contoh komentar multi-baris. * Program ini mencetak "Hello, World!" ke output standar. */ class HelloWorld { public static void main(String[] args) { System.out.println("Hello, World!"); } }
Output:
Hello, World!
Kompiler melewati semua di antara /* dan */. Ini juga disebut komentar tradisional.
Menggunakan Komentar dengan Efektif
Komentar tidak boleh menggantikan kode yang jelas. Tulis kode yang terstruktur dan dapat dijelaskan sendiri terlebih dahulu, kemudian tambahkan komentar untuk menjelaskan "mengapa" di balik keputusan—algoritma yang kompleks, pilihan desain, atau logika yang tidak terlihat.
Sementara beberapa orang mendukung komentar minimal, penjelasan singkat dapat sangat meningkatkan keterbacaan untuk pemelihara di masa depan.
Catatan: Gunakan komentar yang menjelaskan mengapa sebuah kode ada daripada bagaimana itu bekerja.
