javascriptCommentکامنت در جاوااسکریپت
کامنت در جاوااسکریپت برای توضیح دلیل تصمیم‌هاست؛ نوشتن توضیح یک‌خطی و چندخطی، تفاوت با متن قابل نمایش و خطای رایج را با مثال ببینید.
مفهوم به زبان ساده
کامنت توضیحی در متن کد است که به‌عنوان دستور برنامه اجرا نمی‌شود. با // می‌توان ادامهٔ همان خط را توضیح کرد؛ با /* و */ نیز یک توضیح بلوکی می‌نویسیم که می‌تواند چند خط داشته باشد. کاربردش کمک به خوانندهٔ کد است، مثلاً روشن‌کردن اینکه چرا هزینهٔ ارسال جدا از قیمت کالا حساب شده است.
توضیح خوب فقط همان چیزی را که از روی کد معلوم است تکرار نمی‌کند. نوشتن «عدد را جمع می‌کنیم» کنار یک جمع ساده معمولاً کمک زیادی ندارد؛ توضیح واحد پول، محدودیت آموزشی یا دلیل انتخاب روش مفیدتر است. کامنت اگر با تغییر کد به‌روز نشود، ممکن است خواننده را گمراه کند. نام‌گذاری روشن #variable و #function همچنان لازم است.
در مثال، مبلغ‌ها تومان‌اند و ارسال در این سناریوی آموزشی ثابت فرض شده است؛ همین فرض در کامنت نوشته می‌شود. یک خط چاپ هم موقتاً غیرفعال شده است، پس در خروجی دیده نمی‌شود. برای تمرین، توضیح هزینهٔ ارسال را حذف کنید و از خود بپرسید آیا هنوز معلوم است این عدد از کجا آمده است. کامنت جای نمایش پیام به کاربر را نمی‌گیرد؛ برای خروجی کنسول همچنان باید دستور چاپ داشته باشیم.
کجا به کار می‌آید؟
- ثبت واحد اندازه‌گیری یا دلیل یک تصمیم غیرآشکار در کد
- غیرفعال‌کردن موقت یک خط هنگام بررسی مثال
از تعریف تا یک مثال واقعی
// همهٔ مبلغ‌های این مثال به تومان‌اند.
const price = 80000;
/* ارسال برای این سناریوی آموزشی ثابت است؛
قانون عمومی قیمت‌گذاری فروشگاه نیست. */
const shipping = 20000;
// console.log("این خط اجرا نمی‌شود");
console.log(price + shipping);
100000
این مثال چطور کار می‌کند؟
توضیح خط اول واحد مبلغ‌ها را روشن می‌کند.
کامنت بلوکی فرض مربوط به هزینهٔ ارسال را ثبت می‌کند.
خط چاپ کامنت‌شده اجرا نمی‌شود؛ فقط مجموع ۱۰۰۰۰۰ چاپ می‌شود.
اشتباه رایج
کامنت‌های بلوکی را داخل یکدیگر قرار ندهید؛ نخستین */ توضیح را می‌بندد. همچنین حذف // از خط غیرفعال، آن را دوباره به دستور اجرایی تبدیل می‌کند.
این را به خاطر بسپارید
در کامنت دلیل و فرض را بنویسید و هم‌زمان با کد آن را به‌روز نگه دارید.