کامنت‌ها در C++

کامنت‌ها در C++

کامنت‌ها (Comments) توضیحاتی در کد هستند که توسط کامپایلر نادیده گرفته می‌شوند. آن‌ها برای توضیح کد و افزایش خوانایی استفاده می‌شوند.

انواع کامنت‌ها

۱. کامنت تک‌خطی (Single-line Comment)

با دو اسلش (//) شروع می‌شود و تا پایان خط ادامه می‌یابد.

// این یک کامنت تک‌خطی است
int x = 5;  // کامنت بعد از دستور

۲. کامنت چندخطی (Multi-line Comment)

با /* شروع و با */ پایان می‌یابد و می‌تواند چند خط را شامل شود.

/* این یک
   کامنت چندخطی است
   که می‌تواند چند خط را شامل شود */

کاربردهای کامنت‌ها

۱. توضیح کد

// محاسبه مساحت مستطیل
int area = width * height;

۲. موقت کردن کد

// cout << "این خط چاپ نمی‌شود";
cout << "این خط چاپ می‌شود";

۳. مستندسازی

/**
 * تابعی برای محاسبه فاکتوریل
 * @param n عدد ورودی
 * @return فاکتوریل n
 */
int factorial(int n) {
    if (n <= 1) return 1;
    return n * factorial(n - 1);
}

بهترین شیوه‌ها

• کامنت‌ها را به‌روز نگه دارید
• از کامنت‌های واضح و مختصر استفاده کنید
• چیزی را ننویسید که از کد مشخص است
• از کامنت برای توضیح "چرا" استفاده کنید، نه "چی"
• کامنت‌های فارسی بنویسید

نکات مهم

• کامنت‌ها روی سرعت برنامه تأثیری ندارند
• کامنت‌های چندخطی نمی‌توانند تو در تو باشند
• از کامنت برای پنهان کردن باگ‌ها استفاده نکنید