روش های کامنت گذاری در پی اچ پی

در پی اچ پی آنچه بین تگ های باز و بسته  PHP می آید به عنوان دستوراتی که باید اجرا شوند در نظر گرفته می شود مگر اینکه بخشی از کد را به عنوان کامنت علامت گذاری کنید. سه دلیل برای این کار به شرح زیر است:

• برای درج یک یادآوری از آنچه اسکریپت انجام می دهد

• برای درج مکان نگهدار برای کدی که بعداً اضافه می شود

• برای غیرفعال کردن موقت بخشی از کد

هنگامی که تازه کد های php را می نویسید، ممکن است درج چیزی که قرار نیست پردازش شود غیرضروری به نظر برسد. با این حال، اگر چندین ماه بعد, نیاز به اصلاح اسکریپت داشته باشید، خواندن کامنت بسیار آسان‌تر از دنبال کردن تمام کدها است. هنگامی که در یک تیم کار می کنید، کامنت ها بیشتر حیاتی به نظر می رسند.

آنها به همکاران شما کمک می کنند تا بفهمند چه کاری باید انجام بدهند.

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

سه راه برای اضافه کردن کامنت وجود دارد: دو راه برای کامنت های تک خطی و یک راه هم برای کامنتی که می خواهید در چندین خط بنویسید.

رایجترین نوع کامنت گذاری تک خطی با دو اسلش در شروع جمله انجام می شود، مانند این:

// this is a comment and will be ignored by the PHP engine

PHP همه چیز را از دو اسلش تا انتهای خط نادیده می گیرد، بنابراین می توانید کامنت را در کنار کد قرار دهید (اما فقط در سمت راست):

$startYear = 2018; // this is a valid comment

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

یک سبک جایگزین برای کامنت گذاری استفاده از علامت هش یا پوند (#) است، مانند این:

# this is another type of comment that will be ignored by the PHP engine

$startYear = 2018; # this also works as a comment

این سبک کامنت گذاری اغلب بخش‌هایی از یک اسکریپت طولانی‌تر را نشان می‌دهد، مانند این:

##################

## Menu section ##

##################

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

برای اینکه یک کامنت روی چندین خط نوشته شود، از همان سبکی که در CSS و جاوا اسکریپت استفاده می‌شود، استفاده کنید. هر چیزی بین /* و */ به عنوان یک کامنت در نظر گرفته می شود، مانند این:

/* This is a comment that stretches

over several lines. It uses the same

beginning and end markers as in CSS. */

نظرات چند خطی به ویژه هنگام آزمایش یا عیب یابی مفید هستند، زیرا می توان از آنها برای غیرفعال کردن بخش های طولانی یک اسکریپت بدون نیاز به حذف آنها استفاده کرد.