کامنت‌ها در لوا

کامنت چیست؟

کامنت (Comment) متنی است که مفسر لوا آن را نادیده می‌گیرد. کامنت‌ها برای توضیح کد به انسان‌ها (از جمله خودِ آینده‌ی شما!) استفاده می‌شوند.

کامنت تک‌خطی

با دو علامت خط تیره (--) شروع می‌شود و تا پایان همان خط ادامه دارد:

-- این یک کامنت تک‌خطی است
print("سلام")  -- این هم کامنت است (بعد از کد)

کامنت چندخطی

برای کامنت‌های طولانی، از --[[ برای شروع و ]] برای پایان استفاده کنید:

--[[
این یک کامنت چندخطی است.
می‌تواند چند خط ادامه داشته باشد.
مفسر همه این خطوط را نادیده می‌گیرد.
]]
print("سلام دنیا!")

ترفند: کامنت‌گذاری سریع کد

می‌توانید با اضافه کردن یک خط تیره، یک کامنت چندخطی را «باز» کنید:

---[[
print("این خط اجرا می‌شود!")
--]]
-- با اضافه کردن یک - به اول، کامنت غیرفعال شد و کد اجرا شد

کامنت‌های مستندسازی

برای توابع، یک قرارداد رایج وجود دارد:

-- محاسبه مجموع دو عدد
-- @param a عدد اول
-- @param b عدد دوم
-- @return مجموع a و b
local function sum(a, b)
  return a + b
end

چرا کامنت بنویسیم؟

• یادآوری: کدی که ۶ ماه پیش نوشته‌اید، مثل کد یک غریبه به نظر می‌رسد!
• همکاری: دیگران (و خودتان) کد را سریع‌تر می‌فهمند
• تست موقت: غیرفعال کردن بخشی از کد برای دیباگ
• توضیح «چرا»: کد می‌گوید «چه»، کامنت می‌گوید «چرا»

مثال‌های خوب و بد کامنت

-- ❌ بد: کامنت بی‌فایده
local age = 25  -- متغیر age را 25 قرار دادم

-- ✅ خوب: توضیح دلیل
local MAX_RETRIES = 3  -- بعد از ۳ بار تلاش ناموفق، قطع می‌کنیم