PHP

PHP — توضیحات چندخطی (Multiline Comments) در PHP

آخرین بروزرسانی: 1404/07/21

توضیحات چندخطی (Multiline Comments) در PHP

در زبان برنامه نویسی PHP، توضیحات چندخطی یا Multiline Comments زمانی استفاده می شوند که بخواهید توضیحات طولانی تری در چند خط بنویسید یا بخشی از کد را موقتاً غیرفعال کنید. این روش باعث می شود کد شما خواناتر و مدیریت آن آسان تر شود.

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

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

/* این یک توضیح چندخطی است
که در چند خط نوشته می شود */
echo "Welcome Home!";

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

استفاده از توضیحات چندخطی برای غیرفعال کردن کد

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

/*
echo "Welcome to my home!";
echo "Mi casa su casa!";
*/
echo "Hello!";

نکته: این روش برای تست سریع قسمت های مختلف کد بسیار کاربردی است.

توضیحات در میانه کد

در PHP می توانید توضیحات چندخطی را در میانه ی یک خط کد قرار دهید تا بخشی از دستور نادیده گرفته شود. این روش در زمان دیباگ (Debug) یا آزمایش محاسبات مفید است.

$x = 5 /* + 15 */ + 5;
echo $x;

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

برای یادگیری بیشتر درباره کامنت ها در PHP یا آشنایی با ساختار کلی PHP می توانید بخش های مربوطه را مطالعه کنید.