کامنتها در C
نوشتن توضیحات در کد با کامنتهای تکخطی و چندخطی برای خوانایی بهتر برنامه
کامنتها چیست؟
کامنتها توضیحاتی هستند که در کد نوشته میشوند اما توسط کامپایلر نادیده گرفته میشوند. آنها فقط برای انسانها هستند تا کد را بهتر بفهمند.
کامنت تکخطی //
هر چیزی بعد از // تا انتهای خط، کامنت محسوب میشود:
// این یک کامنت است
printf("Hello"); // این هم کامنت است
کامنت چندخطی /* */
برای توضیحات چندخطی از /* */ استفاده میشود:
/* این یک کامنت
چند خطی است
که چند خط را پوشش میدهد */
printf("Hello");
کاربردهای کامنت
- توضیح کد: بیان اینکه کد چه کاری انجام میدهد
- مستندسازی: نوشتن اطلاعات درباره تابع یا فایل
- غیرفعال کردن کد: موقتاً جلوگیری از اجرای بخشی از کد
مثال: غیرفعال کردن کد
// printf("این خط اجرا نمیشود");
printf("این خط اجرا میشود");
بهترین شیوهها
- کامنت را کوتاه و واضح بنویسید
- «چرا» را توضیح دهید نه «چه» — کد خودش نشان میدهد چه میکند
- کامنتهای قدیمی و بیربط را حذف کنید
- از کامنت برای غیرفعال کردن کد در حین تست استفاده کنید (debug)
نکات مهم
- کامنتهای چندخطی قابل تودرتو (nested) نیستند:
/* /* */ */خطا میدهد - کامنت تکخطی
//از استاندارد C99 اضافه شد اما همه کامپایلرهای مدرن از آن پشتیبانی میکنند
این مبحث بخشی از دوره آموزش کامل زبان C است.