آموزش GAMS – قسمت ۱۲ : کامنت‌گذاری در کد (Ontext/Offtext)

کامنت‌گذاری چیست؟

در GAMS، کامنت‌گذاری به افزودن توضیحات به کد گفته می‌شود تا هدف هر بخش (مثل مجموعه‌ها یا معادلات) مشخص شود. این توضیحات توسط GAMS نادیده گرفته می‌شوند و فقط برای خوانایی کد هستند.

روش‌های کامنت‌گذاری در GAMS

1. کامنت تک‌خطی با *:
   • برای توضیحات کوتاه در ابتدای خط استفاده می‌شود.
   • مثال: * این یک کامنت است
2. کامنت چندخطی با Ontext/Offtext:
   • برای توضیحات طولانی‌تر یا چندین خط استفاده می‌شود.
   • مثال:$Ontext این یک مدل حمل‌ونقل ساده است برای کمینه کردن هزینه حمل کالا $Offtext
3. توضیحات در تعریف اجزا:
   • در تعریف مجموعه‌ها، پارامترها، یا معادلات می‌توانید توضیحات را در نقل‌قول (” “) اضافه کنید.
   • مثال: Sets i “شهرهای مقصد” /Tehran, Shiraz/

چرا کامنت‌گذاری مهم است؟

• خوانایی: کد را برای خودتان و دیگران قابل‌فهم می‌کند.
• اشکال‌زدایی: کمک می‌کند بخش‌های مختلف کد را سریع‌تر شناسایی کنید.
• همکاری: در پروژه‌های تیمی، توضیحات واضح کار را ساده‌تر می‌کند.
• مستندسازی: برای مرور کد در آینده یا آموزش دیگران مفید است.

نحوه کامنت‌گذاری در GAMS

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

برای توضیح یک خط خاص:

* تعریف مجموعه شهرها
Sets i /Tehran, Shiraz/;

۲. کامنت چندخطی

برای توضیحات طولانی‌تر:

$Ontext
این مدل برای کمینه کردن هزینه حمل طراحی شده است.
داده‌ها شامل هزینه و تقاضای شهرها هستند.
$Offtext

۳. توضیحات در تعریف

برای اجزای مدل: