آموزش جامع کامنت‌نویسی در PHP


🎯 اهداف یادگیری

  • آشنایی با انواع کامنت در PHP
  • یادگیری اصول کامنت‌نویسی مؤثر
  • تفاوت کامنت‌های تک‌خطی و چندخطی
  • کاربرد DocBlock برای مستندسازی

📌 انواع کامنت در PHP

php
// این یک کامنت تک‌خطی است
# این هم یک کامنت تک‌خطی دیگر (سبک shell)
/*
* این یک کامنت چندخطی است
* می‌تواند چندین خط را پوشش دهد
*/

مقایسه انواع کامنت:

نوع سینتکس کاربرد
تک‌خطی // یا # توضیحات کوتاه
چندخطی /* */ توضیحات طولانی

📌 مستندسازی با DocBlock

استاندارد حرفه‌ای برای مستندسازی کلاس‌ها و متدها:

php
/**
* محاسبه تخفیف برای کاربران
*
* @param float $price قیمت اصلی
* @param float $discount میزان تخفیف (بین 0 تا 1)
* @return float قیمت پس از تخفیف
* @throws InvalidArgumentException اگر تخفیف نامعتبر باشد
*/
function calculateDiscount($price, $discount)
{
if ($discount < 0 || $discount > 1) {
throw new InvalidArgumentException('تخفیف باید بین 0 و 1 باشد');
}
return $price * (1 - $discount);
}

📌 تمرین عملی

تابع زیر را با کامنت و DocBlock کامل کنید:

php
function calculateBMI($weight, $height)
{
return $weight / ($height * $height);
}