Comments در PHP

کامنت‌ها در PHP

Comments in PHP
کامنت چیست؟
کامنت یا توضیح، بخشی از کد است که توسط مفسر PHP اجرا نمی‌شود و برای توضیح دادن کد، یادداشت‌گذاری، مشخص کردن بخش‌های مختلف برنامه و افزایش خوانایی کد استفاده می‌شود.

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

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

مهم‌ترین کاربردهای کامنت عبارت‌اند از:

  • توضیح عملکرد یک بخش از برنامه
  • افزایش خوانایی کد
  • یادداشت‌گذاری برای برنامه‌نویس
  • مشخص کردن بخش‌های مهم برنامه
  • غیرفعال کردن موقت یک خط یا بخشی از کد

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

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

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

<?php

// This is a comment
echo "Hello PHP";

?>

در مثال بالا، خطی که با // شروع شده است، کامنت است و اجرا نمی‌شود.

کامنت در انتهای یک خط کد

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

<?php

echo "Hello"; // Display a message

?>
نکته: کامنت هیچ تأثیری بر نتیجه اجرای برنامه ندارد و فقط برای توضیح یا مدیریت کد استفاده می‌شود.

استفاده از علامت # برای کامنت

روش دیگری برای ایجاد کامنت تک‌خطی در PHP استفاده از علامت # است.

<?php

# This is also a comment

echo "Hello PHP";

?>

در این روش نیز هر چیزی که بعد از علامت # در همان خط قرار داشته باشد، به‌عنوان کامنت در نظر گرفته می‌شود.

مقایسه دو روش کامنت تک‌خطی

روش نمونه نوع
علامت دو اسلش // Comment تک‌خطی
علامت مربع # Comment تک‌خطی
پیشنهاد: در پروژه‌های امروزی PHP معمولاً استفاده از // رایج‌تر است و خوانایی مناسبی دارد.

استفاده از کامنت برای غیرفعال کردن کد

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

<?php

echo "First message";

// echo "Second message";

echo "Third message";

?>

در این مثال، دستور دوم اجرا نمی‌شود؛ زیرا با // به کامنت تبدیل شده است.

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

می‌توان برای توضیح هدف یک متغیر نیز از کامنت استفاده کرد.

<?php

$name = "Ali"; // User's name
$age = 25;     // User's age

echo $name;
echo $age;

?>

کامنت در کدهای ترکیبی PHP و HTML

زمانی که PHP و HTML در یک فایل استفاده می‌شوند، باید توجه داشت که کامنت PHP با کامنت HTML متفاوت است.

برای بخش PHP می‌توان از // یا # استفاده کرد.

اما برای بخش HTML از ساختار مخصوص کامنت HTML استفاده می‌شود.

<!DOCTYPE html>
<html>
<body>






توجه: کامنت HTML و کامنت PHP از نظر ساختار با یکدیگر متفاوت هستند. کامنت PHP برای کدهای PHP و کامنت HTML برای کدهای HTML استفاده می‌شود.

یک مثال کامل

در مثال زیر از کامنت‌ها برای توضیح قسمت‌های مختلف یک برنامه ساده استفاده شده است.

<?php

// Store user information
$name = "Sara";
$age = 22;

// Display the user's name
echo "Name: " . $name;

// Display the user's age
echo "
"; echo "Age: " . $age; ?>

خروجی

Name: Sara
Age: 22

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

  • کامنت‌ها توسط PHP اجرا نمی‌شوند.
  • برای کامنت تک‌خطی می‌توان از // استفاده کرد.
  • روش دیگری برای کامنت تک‌خطی استفاده از # است.
  • کامنت‌ها برای توضیح و مستندسازی کد بسیار مفید هستند.
  • می‌توان با کامنت کردن یک دستور، آن را موقتاً از اجرای برنامه خارج کرد.
  • کامنت PHP و کامنت HTML ساختار متفاوتی دارند.

تمرین

برنامه‌ای بنویسید که نام و سن یک کاربر را در دو متغیر ذخیره کند و آن‌ها را نمایش دهد. سپس:
  1. برای هر متغیر یک کامنت مناسب بنویسید.
  2. برای دستور نمایش نام نیز یک کامنت اضافه کنید.
  3. دستور نمایش سن را با استفاده از // غیرفعال کنید.

جمع‌بندی

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

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