قرار دادن توضیحات comments در اسکریپت های PHP :
گاهی اوقات می خواهید توضیحاتی را در صفحه قرار دهید ، تا در مراجعات بعدی راهنمای شما باشند . یا اینکه اگر کسی غیر از خودتان سورس کد صفحه را مطالعه می کند ، بتواند دریابد هر بخش صفحه چیست و برای چه منظور استفاده می شود . توضیحات را می توانید در هر جای صفحه که بخواهید قرار دهید .
به این توضیحات در طراحی وب comments می گویند . توضیحات توسط مرور گرها نمایش داده نشده و از دید کاربر مخفی هستند و فقط در سورس کد صفحه قابل مشاهده می باشند .
چنانچه توضیح در حد یک خط باشد ، با قرار دادن کد // در ابتدا خط ، توضیح خود را بعد از آن بنویسید .
ولی چنانچه حجم توضیح بیش از یک خط باشد ، باید علامت */ را در ابتدای توضیح و علامت /* را در انتهای آن قرار دهید . از این روش برای توضیحات چند خطی استفاده می شود .
در جدول زیر روش استفاده از هر دو مورد را به صورت عملی به شما نمایش داده ایم:
| // متن توضیح |
Syntax
توضیح یک خطی
|
/*
خط 1 توضیح
خط 2 توضیح
خط 3 توضیح
...
*/
|
Syntax
توضیح چند خطی
|
مثال : درمثال زیر در یک صفحه PHP هم توضیح یک خطی و هم چند خطی قرار داده ایم . دقت کنید که این توضیحات در خروجی نمایش داده نمی شوند :
< html >
< head >
< p > This is a HTML Paragraph < /p >
// متن توضیح یک خطی
echo "Hello World" ;
/*
خط 1 توضیح چند خطی
خط 2 توضیح چند خطی
...
*/
?>
|