Membuat komentar satu baris dan multi baris pada javascript

Komentar pada HTML adalah potongan kode yang digunakan untuk menjelaskan kode-kode yang sedang ditulis dalam menyusun halaman HTML. Komentar ini akan diabaikan oleh browser dan tidak akan ditampilkan pada halaman HTML. Pada halaman HTML dengan kode yang panjang dan kompleks kadang membingungkan dalam menganalisanya. Pemberian komentar akan memberikan kemudahan dalam memahami alur kode yang sedang dikerjakan.

Penulisan komentar pada HTML diawali dengan tag pembuka . Kode-kode HTML baik itu berupa elemen, tag, teks dan lainnya yang terletak di antara tag akan diabaikan oleh browser dan tidak akan ditampilkan pada halaman HTML. Penulisan komentar ini bersifat multi baris yang artinya setelah tag pembuka . Tidak peduli berapa baris kode yang sudah dilewati.

Komentar Untuk Single Line :

Komentar pada single line sering digunakan untuk memberi tanda komentar pada baris tertentu saja. Biasanya komentar ini ditulis dengan singkat pada baris yang bersangkutan.

Berikut ini contoh penulisan komentar HTML untuk baris tunggal :

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

   Penulisan Komentar HTML Tunggal


   
Ini adalah paragraf 1

   
Ini adalah paragraf 2




   
Ini adalah paragraf 3

   
Ini adalah paragraf 4

Pada kode di atas, komentar dibuka pada awal paragraf pertama. Namun komentar ditutup pada awal paragraf yang ke-5 dengan melewati beberapa baris kode HTML. Komentar inilah yang disebut dengan komentar multi baris. Kode HTML yang berada di dalam komentar multi baris tidak akan dieksekusi dan diabaikan oleh web browser. Jika dijalankan pada browser, hasilnya seperti gambar dibawah ini :

Home Programming Cara Memberi Komentar di HTML, PHP, CSS dan JavaScript

By ilham efendi

Komentar dalam pemrograman  menjadi salah satu aspek yang penting agar script yang  ditulis mudah untuk di develop kembali atau juga dalam proses debugging. untuk menulis komentar di source code itu berbeda disetiap bahasa pemrograman , jadi ada aturannya sendiri agar komentar tidak dianggap sebagai statement/perintah.

Untuk artikel ini saya hanya akan membahas tentang  cara membuat komentar di 3 bahasa utama dalam membuat sebuah website yaitu HTML , PHP dan JavaScript. oke langsung ajah berikut caranya.

Memberi Komentar di HTML

Penulisan komentar di html menggunakan tanda baca ini <!– … –> seperti contoh di bawah :

<!-- Komentar di HTML
tidak menjalankan perintah berikut
<img border="0" src="pic_mountain.jpg" alt="Mountain">
 -->

MEMBERI KOMENTAR DI PHP

Selanjutnya penulisan di PHP , ada 3 cara untuk menulis komentar di PHP berikut detailnya

// garis miring untuk menulis komentar dalam satu baris

#pagar juga dalam satu baris

/*
 Sedangkan garis miring dan bintang 
 digunakan untuk menulis komentar dalam
 Beberapa baris
 */

Memberi komentar di CSS

untuk penullisan di CSS menggunakan tanda baca garis miring dengan bintang /* … */ , seperti contoh di bawah

Penulisan Komentar Pada Javascript

Komentar (comment) dalam pemrograman Javascript adalah bagian dari program yang diabaikan oleh compiler sehingga baris komentar tidak memberikan efek apapun bagi suatu program.  Komentar hanya berguna bagi developer untuk mendeskripsikan maksud dari suatu potongan program. Potongan program yang dimaksud dapat berupa kelas, fungsi, variabel, maupun suatu baris program. 

Peringatan: Komentar tidak dibuat untuk mendeskripsikan alur program yang berantakan. Program harus dibuat sebaik dan serapi mungkin sedangkan komentar digunakan untuk mendeskripsikan fungsi dari masing-masing bagian

Komentar Satu Baris (Single-line Comment)

Pada Javascript, baris komentar diawali dengan dua tanda slash (double slash) //

//This comment won't be executed
console.log('Hello world');

Hello world

Komentar Banyak Baris (Multi-line Comment)

Jika komentar memiliki lebih dari satu baris maka komentar dapat diawali tanda slash asterisk /* dan ditutup dengan tanda asterisk slash */

 /* This is main function of Hello World application.
    It is the simplest application in the world */
document.getElementById('output').innerHTML = "Hello world";

Hello world

Komentar Dokumentasi (Documentation Comment)

Komentar dokumentasi (documentation comment) adalah komentar yang dibuat dengan format terstandar sesuai kaidah-kaidah yang diatur oleh Javascript. Komentar dokumentasi berfungsi sebagai alat dokumentasi yang mendeskripsikan suatu variabel, fungsi, kelas, dsb.

Tips: Materi ini berkaitan erat dengan fungsi dan variabel. Ada baiknya sebelum mempelajari materi ini Anda membaca sekilas materi tentang fungsi dan variabel. 

Karena komentar dokumentasi ditulis sesuai format standar maka pada umumnya IDE dapat mengenalinya dan menampilkannya pada deskripsi ketika memunculkan autocomplete. Berikut adalah contoh penggunaan komentar dokumentasi pada deklarasi fungsi:

Bagaimana membuat komentar di JavaScript bila lebih dari 1 baris kode?

Bagaimana cara menyisipkan komentar yang memiliki lebih dari satu baris?

Tanda apa yang dapat digunakan untuk memberikan komentar satu baris pada JavaScript?

Bagaimana menandai komentar yang benar dalam CSS?