کامنت‌ها

کامنت چیست؟

کامنت‌ها متنی هستند که کامپایلر نادیده می‌گیرد — برای توضیح کد یا موقتاً غیرفعال کردن بخشی از آن.

۱. کامنت تک‌خطی

// این یک کامنت تک‌خطی است
int age = 25;   ← کامنت در انتهای خط

// توضیح خط بعدی
System.out.println(age);

۲. کامنت چندخطی (بلوکی)

/* این یک کامنت چندخطی است
   که چند خط را پوشش می‌دهد
   برای توضیحات طولانی عالی است */
public class Main {
    // ...
}

۳. Javadoc — مستندسازی رسمی

سبک ویژه جاوا که با /** شروع می‌شود — ابزار javadoc از آن مستندات HTML می‌سازد:

/**
 * جمع دو عدد صحیح را برمی‌گرداند.
 * @param a عدد اول
 * @param b عدد دوم
 * @return مجموع a و b
 */
public static int add(int a, int b) {
    return a + b;
}

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

// ۱. توضیح منطق پیچیده
// الگوریتم جستجوی دودویی — O(log n)

// ۲. موقتاً غیرفعال کردن کد (هنگام دیباگ)
// System.out.println("مقدار x: " + x);

// ۳. علامت‌گذاری بخش‌ها
// ===== بخش اصلی =====

// ۴. TODO — کارهای باقی‌مانده
// TODO: اعتبارسنجی ورودی اضافه شود

قراردادهای خوب

• کامنت باید بگوید «چرا»، نه «چه» — کد خودش نشان می‌دهد چه می‌کند
• کامنت‌های قدیمی را با تغییر کد به‌روز کنید
• کامنت گمراه‌کننده بدتر از نبود کامنت است!