هدف از کامنت گذاری همانطور که قبلا اعلام شد توضیح درباره کدهای نوشته شده است تا خوانایی آنها را توسط خودمان و دیگران بالا ببریم.همچنین زمانی که بخواهیم جلوی اجرای یک دستور را در هنگام تست کردن کد بگیریم از کامنت استفاده می کنیم.
انواع کامنت گذاری (مدل تک خطی)
اگر نیاز داریم که تنها یک خط را کامنت یا غیرفعال کنیم از // در ابتدای خط استفاده می کنیم.این روش در کامنت های چندخطی جواب نمی دهد.
مثال:
|
1 2 3 4 5 |
// Change heading: document.getElementById("myH") = "My First Page" // Change paragraph: document.getElementById("myP") = "My first paragraph." |
در مثال زیر توضیح هر کدام جلوی دستورات آن نوشته شده است.
مثال:
|
1 2 |
let x = 5; // Declare x, give it the value of 5 let y = x + 2; // Declare y, give it the value of x + 2 |
انواع کامنت گذاری (چند خطی)
در صورتی که نیاز است چندین خط کامنت گذاری شود به جای تک تک کامنت کردن هر خط از /**/ استفاده می کنیم.معمولا از این روش در توضیح و مستند کردن کد استفاده می شود.
مثال:
|
1 2 3 4 5 6 7 8 |
/* The code below will change the heading with id = "myH" and the paragraph with id = "myP" in my web page: */ document.getElementById("myH") = "My First Page" document.getElementById("myP") = "My first paragraph." |
استفاده از کامنت برای جلوگیری از اجرای کد
در زمانی که قصد داشته باشیم کد خود را تست و یا خطایابی کنیم از کامنت کردن استفاده می کنیم.
در مثال زیر از // برای کامنت کردن کد استفاده شده است.
مثال:
|
1 2 |
//document.getElementById("myH") = "My First Page" document.getElementById("myP") = "My first paragraph." |
در مثال زیر از کامنت چند خطی برای تست کد استفاده شده است.
مثال:
|
1 2 3 4 |
/* document.getElementById("myH") = "My First Page" document.getElementById("myP") = "My first paragraph." */ |
