komentar

Peringatan

Jika kamu sudah mempelajari C, C++, Java atau C#, kamu bisa melewati pelajaran ini. Alasannya, komentar pada Rust hampir sama dengan bahasa-bahasa tersebut.

Apa itu komentar?

Teks penjelasan yang ditulis untuk dibaca manusia, akan diabaikan oleh kompiler dan tidak ikut berjalan saat program dieksekusi.

Apa saja fungsi dari komentar?

• Menjelaskan fungsi kode: agar orang lain mudah memahami kode yang dibuat
• Mencatat informasi pembuatan: digunakan untuk menghasilkan file dokumentasi tertentu
• Menyembunyikan kode sementara: kode tidak perlu dihapus, hanya tidak ingin dijalankan dengan cara diberi komentar
• Meningkatkan keterbacaan kode

Dua / tiga jenis komentar di Rust

• Komentar baris: dimulai dengan // dan berlaku sampai akhir baris
• Komentar blok: bisa membungkus banyak baris kode sekaligus, sintaks penutup dan pembuka /* ... */

Komentar mirip dengan catatan yang kamu tulis di buku pelajaran saat belajar, untuk membantu memahami isi materi.

Kita akan mempelajari dua jenis komentar yang umum terlebih dahulu, kemudian jenis ketiga di sesi berikutnya.

fn main() {
    // Komentar satu baris dimulai dengan dua garis miring hingga akhir baris.
    // Semua tulisan setelah garis miring pada baris ini akan diabaikan kompiler.

    // Contoh: baris kode ini tidak akan dijalankan
    // println!("Hello, world!");

    // Coba hapus dua garis miring di atas lalu jalankan kode kembali.

    /*
     * Komentar blok berguna untuk menonaktifkan kode sementara, lihat contoh di bawah
     * Mendukung bersarang: /* seperti ini */, cepat sembunyikan potongan kode panjang sekaligus.
     */

    /*
     * println!("Hello, world!");
     * println!("Hello, world2!");
     */

    /*
Catatan: tanda bintang di kolom kiri hanya untuk tampilan rapi,
bukan syarat sintaks bahasa, boleh tidak ditulis.
    */

    // Cukup tambah atau hapus satu garis miring untuk aktif/nonaktif komentar blok dengan cepat:

    /* <- Tambah satu garis miring di sini untuk batalkan seluruh komentar blok di bawah (tambahkan / sebelum /* jadi //*, silakan coba sendiri)
    
    println!("Sekarang");
    println!("Semua");
    println!("kode akan berjalan!");
    // Komentar baris di dalam tidak akan terpengaruh

    // */

    // Komentar blok juga bisa diletakkan di tengah ekspresi:
    let x = 5 + /* 90 + */ 5;
    println!("Apakah `x` bernilai 10 atau 100? x = {}", x);
}Code language: PHP (php)

Salin kode di atas dan coba jalankan sendiri, bagian yang perlu diperhatikan yaitu /* <- Tambah satu garis miring di sini untuk batalkan seluruh komentar blok di bawah

(Penjelasan: tambah tanda / di depan /* menjadi //*, penanda awal komentar blok jadi tidak berlaku, sedangkan bagian // */ di belakang dianggap komentar baris.)

Dengan begitu komentar blok sementara terhapus, dan perintah println di tengah akan bisa dieksekusi.

Komentar dokumentasi

Komentar dokumentasi bisa diolah menjadi dokumen format HTML dengan alat khusus, agar programmer mudah membaca referensi. Kita akan bahas materi ini di pelajaran terpisah selanjutnya.