Comments چندخطی در PHP

کامنت‌های چندخطی در PHP

Multiline Comments in PHP
کامنت چندخطی چیست؟
زمانی که بخواهیم توضیحی را در چند خط بنویسیم یا چندین خط از کد را به‌صورت موقت غیرفعال کنیم، می‌توانیم از کامنت چندخطی در PHP استفاده کنیم.

ساختار کامنت چندخطی

برای ایجاد کامنت چندخطی در PHP از علامت /* برای شروع و علامت */ برای پایان کامنت استفاده می‌شود.

هر چیزی که بین این دو علامت قرار بگیرد، توسط PHP اجرا نمی‌شود؛ حتی اگر در چندین خط نوشته شده باشد.

<?php

/*
This is a multiline comment.
It can contain several lines.
PHP will ignore this text.
*/

echo "Hello PHP";

?>

خروجی

Hello PHP

تفاوت کامنت تک‌خطی و چندخطی

اگر توضیح فقط در یک خط باشد، استفاده از کامنت تک‌خطی ساده‌تر است؛ اما برای توضیحاتی که چند خط دارند، ساختار /* … */ مناسب‌تر است.

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

نوشتن توضیحات چندخطی

یکی از کاربردهای اصلی کامنت چندخطی، توضیح دادن عملکرد یک قسمت از برنامه است. برای مثال، می‌توانیم در ابتدای یک بخش از کد، توضیحی درباره هدف آن بنویسیم.

<?php

/*
Calculate the total price.
The product price is stored
in the $price variable.
*/

$price = 250000;
$quantity = 3;

$total = $price * $quantity;

echo $total;

?>

خروجی

750000

غیرفعال کردن چند خط کد

یکی دیگر از کاربردهای مهم کامنت چندخطی، غیرفعال کردن موقت چندین دستور است. در این حالت لازم نیست خطوط موردنظر را حذف کنیم.

<?php

echo "Start";

/*
echo "Message 1";
echo "Message 2";
echo "Message 3";
*/

echo "End";

?>

خروجی

StartEnd
نکته مهم: در مثال بالا سه دستور بین /* و */ قرار گرفته‌اند؛ بنابراین هیچ‌کدام اجرا نمی‌شوند.

استفاده در یک برنامه واقعی

در پروژه‌های واقعی می‌توان از کامنت چندخطی برای توضیح یک الگوریتم، مشخص کردن هدف یک بخش از برنامه یا ثبت نکات مهم مربوط به یک قسمت از کد استفاده کرد.

<?php

/*
Get the user's score
and determine whether
the student has passed.
*/

$score = 85;

if ($score >= 50) {
echo "Passed";
} else {
echo "Failed";
}

?>

خروجی

Passed

نکات مهم این درس

  • کامنت چندخطی با /* شروع می‌شود.
  • کامنت چندخطی با */ پایان می‌یابد.
  • محتوای بین این دو علامت توسط PHP اجرا نمی‌شود.
  • کامنت چندخطی می‌تواند شامل تعداد زیادی خط باشد.
  • از آن می‌توان برای توضیح بخش‌های پیچیده برنامه استفاده کرد.
  • می‌توان چندین خط کد را موقتاً با کامنت چندخطی غیرفعال کرد.

تمرین

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

جمع‌بندی

در این درس با کامنت‌های چندخطی در PHP آشنا شدیم. ساختار /* … */ به ما اجازه می‌دهد توضیحات چندخطی بنویسیم یا چندین خط از کد را بدون حذف کردن، به‌صورت موقت غیرفعال کنیم.

درس بعدی: در درس بعد با متغیرها در PHP آشنا می‌شویم و نحوه تعریف، مقداردهی و استفاده از متغیرها را بررسی خواهیم کرد.