کامنت‌ها
کامنت‌های تک‌خطی و بلوکی در Go، کامنت‌های مستندسازی و قراردادهای استاندارد.
کامنت چیست؟
کامنت‌ها متنی هستند که کامپایلر نادیده می‌گیرد. برای توضیح کد، یادداشت‌گذاری یا موقتاً غیرفعال کردن بخشی از کد استفاده می‌شوند.
کامنت تک‌خطی
با // شروع می‌شود و تا انتهای خط ادامه دارد:
// این یک کامنت تک‌خطی است
fmt.Println("سلام") ← این هم کامنت است
// می‌توانیم برای توضیح خط بعدی استفاده کنیم
x := 42کامنت بلوکی (چندخطی)
با /* شروع و با */ تمام می‌شود:
/* این یک کامنت بلوکی است
که چند خط را پوشش می‌دهد
برای توضیحات طولانی عالی است */
/*
می‌توانید حتی داخل خط هم استفاده کنید
*/کامنت‌های مستندسازی (Doc Comments)
Go سبک خاصی برای مستندسازی دارد — کامنتی که مستقیماً بالای تعریف قرار گیرد، مستندات رسمی آن می‌شود:
// Add دو عدد صحیح را جمع می‌کند و نتیجه را برمی‌گرداند.
// این کامنت در مستندات رسمی نمایش داده می‌شود.
func Add(a, b int) int {
return a + b
}با دستور
go doc می‌توانید مستندات تولیدشده از کامنت‌ها را ببینید. سایت pkg.go.dev هم مستندات همه پکیج‌های Go را از همین کامنت‌ها می‌سازد!قراردادهای استاندارد
- کامنت‌های مستندسازی با نام خود تعریف شروع می‌شوند:
// Add دو عدد را جمع می‌کند... - برای توضیح «چرا» بنویسید، نه «چه» — کد خودش نشان می‌دهد چه می‌کند
- از کامنت‌های واضح و بامزه نترسید!
کاربردهای کامنت
// ۱. توضیح منطق پیچیده
// الگوریتم فیبوناچی با روش بازگشتی
// ۲. موقتاً غیرفعال کردن کد (هنگام دیباگ)
// fmt.Println("مقدار x:", x)
// ۳. علامت‌گذاری بخش‌ها
// ===== بخش اصلی برنامه =====
/* ۴. توضیحات طولانی
که نیاز به چند خط دارند */کامنت‌های قدیمی و گمراه‌کننده بدتر از نبود کامنت‌اند! همیشه کامنت‌ها را همراه کد به‌روز کنید.
این مبحث بخشی از دوره آموزش کامل گو است.