توضیحات
وقتی که کدی تایپ میکنید شاید بخواهید که متنی جهت یادآوری وظیفه آن کد به آن اضافه کنید. در JavaScript (و بیشتر زبانهای برنامه نویسی) میتوان این کار را با استفاده از توضیحات انجام داد. توضیحات متونی هستند که توسط مفسر نادیده گرفته میشوند و به عنوان بخشی از کد محسوب نمیشوند.
هدف اصلی از ایجاد توضیحات، بالا بردن خوانایی و تشخیص نقش کدهای نوشته شده توسط شما، برای دیگران است. فرض کنید که میخواهید در مورد یک کد خاص، توضیح بدهید، میتوانید توضیحات را در بالای کد یا کنار آن بنویسید. از توضیحات برای مستند سازی برنامه هم استفاده میشود. در برنامه زیر نقش توضیحات نشان داده شده است :
// This line will print the message hello world console.log("Hello World!");
Hello World!
در کد بالا، خط 2 یک توضیح درباره خط 3 است که به کاربر اعلام میکند که وظیفه خط 3 چیست؟ با اجرای کد بالا فقط جمله Hello World چاپ شده و خط 2 در خروجی نمایش داده نمیشود چون مفسر توضیحات را نادیده میگیرد. توضیحات بر دو نوعند :
- توضیحات تک خطی
// single line comment
- توضیحات چند خطی
/* multi line comment */
توضیحات تک خطی همانگونه که از نامش پیداست، برای توضیحاتی در حد یک خط به کار میروند. این توضیحات با علامت // شروع میشوند و هر نوشتهای که در سمت راست آنها قرار بگیرد جز توضیحات به حساب میآید. این نوع توضیحات معمولاً در بالا یا کنار کد قرار میگیرند. اگر توضیح درباره یک کد به بیش از یک خط نیاز باشد از توضیحات چند خطی استفاده میشود. توضیحات چند خطی با */ شروع و با /* پایان مییابند. هر نوشتهای که بین این دو علامت قرار بگیرد جز توضیحات محسوب میشود.