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

کامنت با #، مستندات POD و نشانگر __END__.

کامنت تک‌خطی با #

# این کل یک کامنت است
say "hello";    # کامنت انتهای خط

کامنت چندخطی؟

پرل کامنت چندخطی داخلی ندارد! هر خط باید # خودش را داشته باشد:
# خط اول توضیح
# خط دوم توضیح
# خط سوم توضیح
say "ok";

POD — مستندات داخلی

پرل سیستم مستندسازی داخلی به نام POD (Plain Old Documentation) دارد:

=pod
این بخش مستندات است
و کامپایلر نادیده‌اش می‌گیرد
می‌تواند چند خط باشد
=cut

say "بعد از POD";
=pod شروع و =cut پایان مستندات است. بین این دو، هر چیزی باشد نادیده گرفته می‌شود — مثل کامنت چندخطی!

__END__ — پایان اسکریپت

say "برنامه اصلی";

__END__
هر چیزی بعد از این خط نادیده گرفته می‌شود
حتی کد غلط هم اشکال ندارد

کامنت کجا به کار می‌آید؟

  1. توضیح منطق: چرا این کار را می‌کنید؟
  2. غیرفعال کردن موقت: برای تست
  3. سربرگ: نویسنده، تاریخ، توضیح
# ===================================
# برنامه: محاسبه میانگین نمرات
# نویسنده: دانش‌آموز لرنینگ سیتی
# ===================================

خلاصه

ابزارسینتکسکاربرد
کامنت# ...تک‌خطی
POD=pod ... =cutچندخطی / مستندات
END__END__پایان اسکریپت

این مبحث بخشی از دوره آموزش کامل پرل است.

ابزارهای مرتبط