توضیحات (Comments)
«توضیح (Comment)» یعنی نوشته ای برای انسان ها، نه ماشین. توضیح کد را روشن می کند و موقع تست، جلوی اجرای بخش ها را می گیرد. مثل نُتِ کنار تمرین ریاضی در دفترت.
توضیح تک خطی //
توضیح تک خطی با // شروع می شود. از آن تا آخر خط اجرا نمی شود.
// Change heading:
document.getElementById("myH").innerHTML = "My First Page";
// Change paragraph:
document.getElementById("myP").innerHTML = "My first paragraph.";
گاهی توضیح را آخر خط می گذاریم. باز هم اجرا نمی شود.
let x = 5; // Declare x and set 5
let y = x + 2; // Declare y and set x + 2
توضیح چندخطی /* ... */
برای متن طولانی تر، از /* تا */ استفاده کن. همه این بخش نادیده می شود.
/*
The code below will change
heading with id "myH"
and paragraph with id "myP"
*/
document.getElementById("myH").innerHTML = "My First Page";
document.getElementById("myP").innerHTML = "My first paragraph.";
نکته: معمولاً از تک خطی بیشتر استفاده می شود. چندخطی برای مستندسازی رسمی عالی است.
استفاده برای جلوگیری از اجرا
برای تست، می توانی یک خط را موقتاً غیرفعال کنی. جلوی آن // بگذار.
//document.getElementById("myH").innerHTML = "My First Page";
document.getElementById("myP").innerHTML = "My first paragraph.";
برای خاموش کردن چند خط، از بلاک توضیح استفاده کن.
/*
document.getElementById("myH").innerHTML = "My First Page";
document.getElementById("myP").innerHTML = "My first paragraph.";
*/
گام های عملی
- یک توضیح تک خطی اول کد بنویس.
- همان توضیح را آخر خط هم امتحان کن.
- یک بلاک چندخطی برای معرفی فایل بگذار.
جمع بندی سریع
- // برای خط های کوتاه و سریع.
- /* ... */ برای متن های بلند.
- با توضیح، کد خواناتر می شود.
- برای تست، موقتاً کد را خاموش کن.
نکته: ادامه مسیر: صفحه دستورات جاوااسکریپت و متغیرها را هم ببین. عبارت های بیشتر در ساختار نوشتاری توضیح داده شده است.