Cara Membuat Komentar Single dan Multi Line di JavaScript

Saat menulis kode JavaScript dan kode bahasa pemrograman pada umumnya, terkadang kita perlu menambahkan catatan yang menjelaskan kode tersebut, terlebih jika kode yang kita tulis sudah banyak.

Disinilah komentar bisa menjadi solusi...

Dengan menggunakan komentar kita bisa menambahkan catatan mengenai kode yang kita tulis tanpa khawatir catatan tersebut dieksekusi atau dianggap kode program sesungguhnya oleh mesin JavaScript.

Di JavaScript kita bisa menulis komentar dalam dua cara yakni single line (sebaris) dan multi line (beberapa baris).

Mari kita pelajari lebih lanjut mengenai apa itu komentar dan bagaimana cara membuat komentar single line dan multi line di JavaScript.

Apa Itu Komentar?

Komentar adalah kode atau teks yang tidak akan dieksekusi oleh mesin. Biasanya digunakan untuk menulis catatan dan mencegah eksekusi kode.

Ketika kode yang kita tulis sudah banyak, kita menjadi lebih sulit membaca kode. Misalnya, jika kita memiliki banyak fungsi, terkadang kita lupa parameter dan output dari suatu fungsi.

Komentar juga bisa digunakan untuk mencegah eksekusi kode, biasanya ini dilakukan ketika menguji beberapa kode.

Alih-alih menghapusnya agar mesin JavaScript tidak mengeksekusi kode yang tidak digunakan, kita bisa menambahkan komentar untuk kode tersebut sehingga kita tidak perlu menulis ulang dari awal ketika membutuhkannya.

Cara Membuat Komentar di JavaScript

Di JavaScript kita bisa membuat komentar sebaris (single line) atau beberapa baris (multi line), mari kita pelajari satu per satu.

Komentar Single Line (Sebaris)

Komentar sebaris biasanya digunakan untuk menulis catatan singkat.

Komentar sebaris dimulai dengan // (dua garis miring), kode atau teks apa pun setelahnya di baris yang sama tidak akan dieksekusi.

Contoh komentar sebaris:

// cetak teks "Hello World" ke console
console.log('Hello World');

Komentar Multi Line (Beberapa Baris)

Komentar multi line biasanya digunakan untuk menulis catata yang lebih dari satu baris.

Komentar multi line diawali dengan /* (garis miring bintang) dan diakhiri dengan */ (bintang garis miring).

Kode atau teks apa pun yang berada diantara /* dan */ tidak akan dieksekusi oleh mesin.

Contoh komentar multi line:

/*
fungsi untuk menjumlahkan dua buah nilai
cetak ke console hasil penjumlahan 2 dan 3
*/
const add = (a, b) => a + b;
console.log(add(2, 3));

Kita juga bisa menyematkan komentar multi line di tengah-tengah kode:

const perkenalkan = (nama /* umur */) => `hi, saya ${nama}`;

atau, kita juga bisa menulis markup JSDoc untuk membuat catatan yang terstruktur...

Misalnya untuk sebuah fungsi kita bisa mencatat parameter yang dibutuhkan oleh fungsi tersebut beserta tipe datanya dan apa yang dikembalikan oleh fungsi tersebut.

Contoh komentar multi line dengan markup JSDoc:

/**
 * Jumlahkan dua buah nilai
 * @param {number} a nilai a
 * @param {number} b nilai b
 * @returns {number} jumlah dari a dan b
 */
const add = (a, b) => a + b;

Keuntungan menggunakan markup JSDoc ketika kita mengarahkan kursor ke nama fungsi, kode editor akan menampilkan catatan yang telah kita tulis secara terstruktur.

Kesimpulan

Jadi, kode atau teks yang diberi komentar tidak akan dieksekusi oleh mesin.

Di JavaScript kita bisa menulis komentar single line untuk membuat catata singkat maupun multi line untuk catata yang berisi banyak baris.

Selain bisa digunakan untuk membuat catatan, komentar juga bisa digunakan untuk mencegah eksekusi kode, biasanya digunakan ketika kita ingin menguji beberapa kode.

Namun, banyak pengembang yang menyarankan untuk tidak menulis komentar. Sebisa mungkin kode yang kita tulis mendeskripsikan dirinya sendiri, sehingga komentar tidak diperlukan.

Oleh karena itu, saat membuat variabel, fungsi, objek, kelas dan yang lainnya, gunakan nama yang sesuai.