توضیحات (کامنتها) در پی اچ پی
اگر تجربه برنامه نویسی را داشته باشید حتما تایید می کنید که نوشتن توضیحات در مورد کدهای نوشته شده در بسیاری موارد مفید است. هرچند کدها را خودتان می نویسید اما در آینده ممکن است دقیقا ندانید که چه کاری را انجام داده اید یا ممکن است بخواهید بعدها کدهای خود را در اختیار دیگران قرار دهید؛ مسلما کدهایی که شامل توضیحات باشند بسیار قابل فهم تر توسط دیگران خواهند بود.
توضیحات در پی اچ پی به سبک توضیحات در زبان C,C++و Perl (Shell-style) نوشته می شوند. مثال های زیر را مشاهده کنید:
<?php echo 'در طوک طراحی وب را بیاموزید'; // این یک توضیح یک خطی به شیوه زبان سی پلاس است /* توضیحات چند خطی را به این صورت بنویسید با این روش می توانید توضیحات را در چند خط بنویسید */ echo 'در طوک طراحی وب را بیاموزید'; echo 'در طوک طراحی وب را بیاموزید'; # یک توضیح یک خطی با شیوه shell-style ?>
در روش C توضیحات را به صورت چند خطی می توان به این شکل نوشت:
<?php /* این توضیح با روش سی نوشته شده است در این روش می توانید توضیحات را در چند خط بنویسید */ ?>
هنگامی که از شیوه C برای ایجاد توضیحات چند خطی استفاده می کنید، توجه داشته باشید که توضیحات با رسیدن به اولین علامت */ توضیحات به پایان خواهد رسید. پس توجه داشته باشید که توضیحات با شیوه C را به صورت تودرتو ننویسید.
<?php /* echo 'در طوک طراحی وب سایت را یادبگیرید'; /* این توضیح باعث ایجاد مشکل خواهد شد. */ */ ?>
در روش ++C توضیحات یک خطی به این شکل نوشته می شوند:
<?php // توضیحات یک خطی با شیوه سی پلاس را به این شکل بنویسید ?>
در روش Shell توضیحات یک خطی به این شکل نوشته می شوند:
<?php # توضیحات یک خطی به روش شل را به این شکل بنویسید ?>