توضیحات در کدهای PHP

مقدمه :

زمانی که حجم کدهای PHP بسیار زیاد باشد، می توان برای هر بخش از کدها، توضیحاتی را نوشت تا نویسنده کدها، در آینده با دیدن این توضیحات متوجه شود که هر بخش از کدهای PHP به چه منظوری نوشته شده است.

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

  • نوشتن توضیحات در PHP به صورت تنها در یک خط :

اگر توضیحات تنها در یک خط جا بگیرند، باید قبل از توضیحات، علامت // یا علامت # را بنویسیم. به مثال زیر توجه کنید :

مشاهده می کنید که کلمات نوشته شده در جلوی علامت های // و # (البته در همان خط خودشان) در خروجی نمایش داده نشده است.

  • نوشتن توضیحات در PHP به صورت چندین خط (یک بلوک) :

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

مشاهده می کنید که توضیحات بین علامتهای */ و /* در خروجی نمایش داده نشده است.

بدون دیدگاه

دیدگاهتان را بنویسید

نشانی ایمیل شما منتشر نخواهد شد. بخش‌های موردنیاز علامت‌گذاری شده‌اند *