Komentar pada Kotlin

Muhammad Fajri
Monday, 12 April 2021

Bismillahirrahmanirrahim.

Sama seperti bahasa pemrograman lainnya, di Kotlin pun kita dapat membuat komentar. Beberapa bahasa pemrograman memiliki cara penulisan komentar yang sama.

Komentar digunakan untuk memberikan penjelasan pada program yang dibuat. Dengan komentar ini pula orang lain akan lebih mudah memahami saat membaca program yang kita buat.

Saat menjalankan program, komentar ini tidak akan dieksekusi. Dengan kata lain, ia akan diabaikan oleh compiler.

Komentar Satu Baris

Komentar ini dibuat untuk memberikan keterangan pada suatu baris program. Ditulis dengan menggunakan simbol dua garis miring (//). Compiler akan mengabaikan semua apa yang dituliskan di sebelah kanan simbol ini hingga akhir baris tersebut. Sedangkan yang di sebelah kiri simbol ini akan tetap dieksekusi oleh compiler.

Contoh pembuatan komentar

// Pernyataan ini akan diabaikan
var a = 0 // Pernyataan ini pun akan diabaikan

Komentar Multi Baris

Komentar multi baris juga dikenal sebagai komentar C-style. Disebut seperti itu karena komentar ini pada dasarnya dari bahasa C.

Contoh:

/* Apapun yang ada di antara pasangan tanda
garis miring dan asterisk akan diabaikan oleh
compiler
*/

Contoh lain:

fun main() {
    var a = 100
    a += a
    println(a)
    a -= a
    println(a)
    a *= a
    println(a)
/*    a /= a
    println(a)
*/
}

Dari contoh di atas, dapat lihat bahwa komentar dapat digunakan agar baris kode yang dibuat tidak dieksekusi oleh compiler. Alasannya apakah baris kode tersebut dapat memuat error jika dieksekusi atau untuk memberikan keterangan bahwa terdapat cara lain untuk membuat baris kode tersebut.

Komentar dengan KDoc

KDoc, sama seperti Javadoc pada Java, digunakan untuk membuat komentar yang diantarai oleh /** dan */. Komentar ini mirip seperti komentar multi baris, akan tetapi komentar ini digunakan untuk menyediakan dokumentasi API pada kode Kotlin.

Berikut contoh programnya.

/**
This is an example documentationusing KDoc syntax

@author Muhammad Fajri
@constructor
*/
class Person(val name: String) {
    /**
    This is another KDoc comment
    */
    fun foo(): Int {
        
    }
}

Referensi

  1. Modul Pemrograman Mobile (Mobile Programming).
  2. Hagos, Ted. 2018. Learn Android Studio 3 with Kotlin: Efficient Android App Development. Apress: Manila.