6. Komentar (Tutorial KOTLIN - Bahasa Indonesia)

 

Jadi, apa sebenarnya komentar itu dan untuk apa kita membutuhkannya? Nah, intinya, itulah yang kita sebut sebagai teks khusus yang akan diabaikan oleh compiler. Komentar memungkinkan Anda mengklarifikasi sepotong kode atau mengecualikannya dari proses kompilasi (yaitu, menonaktifkannya). Sepanjang kursus ini, kami akan menggunakan komentar untuk menjelaskan bagaimana dan mengapa kode berfungsi.

 

 

Komentar Akhir Baris

Setelah "//", kompiler mengabaikan teks yang tersisa di baris.

 

fun main() {
    // The line below will be ignored
    // println("Hello, World")

    // This prints the string "Hello, Kotlin"
    println("Hello, Kotlin")  // Here can be any comment
    /// Valid single-line comment
}

 

 Tahukah kamu? Di sebagian besar editor kode, sebuah baris dapat dikomentari dengan menempatkan tanda sisipan pada baris tersebut dan menekan Ctrl / atau cmd /.

 

Komentar Multi-Baris

Kompiler mengabaikan teks apa pun di antara simbol /* dan */. Anda dapat menggunakannya untuk menulis komentar satu baris dan banyak baris:

 

fun main() {
    /* This is a single-line comment */
    /*  This is an example of
        a multi-line comment */

    /*** Valid multiline comment
        println("Hello")
        println("World")
    **/
}

 

Anda juga dapat memasukkan komentar di dalam komentar lain. Saat menulis komentar bersarang multi-baris, pastikan tanda /* dan tanda penutup */ berpasangan.

 

fun main() {
    /*
    System.out.println("Hello")  // print "Hello"
    System.out.println("Kotlin") /* print "Kotlin" */
    */
}

 

Komentar dokumentasi (komentar dokumen)

Kompiler mengabaikan teks apa pun di antara tanda /** dan */ sama seperti ia mengabaikan semua teks dalam komentar multi-baris. Komentar semacam ini disebut komentar dokumentasi (komentar dokumen). Dokumentasi adalah teks yang membantu orang lain memahami apa yang dilakukan kode Anda. Anda dapat menggunakan jenis komentar ini untuk membuat dokumentasi tentang kode sumber Anda secara otomatis menggunakan alat khusus.

Biasanya, komentar ini ditempatkan di atas deklarasi dari masing-masing elemen program. Selain itu, dalam hal ini, beberapa label khusus, seperti @param, @return, dan lainnya digunakan untuk mengontrol alat.

Mari kita lihat contoh di bawah ini.

 

/**
 * The `main` function accepts string arguments from outside.
 *
 * @param args arguments from the command line.
 */
fun main(args: Array<String>) {
    // do something
}

 

Jangan takut jika Anda belum sepenuhnya memahami komentar dokumentasi. Nanti, kita akan melihat lebih dekat pada mereka.

 

Kita telah membahas secara singkat beberapa jenis komentar yang dapat Anda masukkan ke dalam kode Anda. Gunakan dengan bijak dan ingat bahwa banyak komentar tidak selalu membuat program Anda benar-benar jelas. Kode dapat berubah, dan komentar akan menjadi usang. Untuk mengurangi jumlah komentar, Anda harus menulis kode yang mendokumentasikan diri sendiri, yang mungkin tidak sesederhana itu bagi pemula. Kita akan belajar bagaimana melakukannya pada tutorial berikut-berikutnya.