انواع کامنت گذاری در زبان php

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

کامنت گذاری ربطی به میزان کد شما ندارد و حتی ممکن است میزان کد شما نهایتا 100 خط باشد و اینگونه احساس کنید که چون تعداد خط کد پروژه کم است پس نیازی به کامنت گذاری نیست ، درحالیکه اینگونه نبوده و شما جهت خوانایی پروژه و همچنین تحلیل بهتر آن توسط برنامه نویسان یا کاربران بعدی لازم است تا کامنت گذاری اصولی انجام دهید . لازم است بدانید که بخش‌های کامنت شده در داخل کدها اجرا نشده و در خروجی نیز نمایش داده نخواهند شد و اصول آنها بر توصیه و خوانایی استوار است . چه زمانی به کامنت گذاری نیاز داریم ؟

• جهت توضیح بخش‌هایی از کد شما که درک آن بعدها برای خود شما یا سایر کاربران نیاز به اطلاعات بیشتری دارد
• غیرفعال کردن بخشی از کد در فرآیند اجرای کدها
• قرار دادن توضیحات برای شخص توسعه دهنده جهت راحتی برخورد با پروژه در آینده ( درمورد توابع و کلاس و … )
• کدنویسی خوانا و تمیز و همچنین مستندسازی اصولی
• بهبود فرآیند دیباگینگ و همچنین توسعه
• کاهش احتمال اشتباهات در پروژه در فرآیندهای بعدی

پس از این جهت پروسه کامنت گذاری بسیار مهم بوده و لازم است تا بصورت دقیق و اصولی انجام شود . زبان برنامه‌نویسی php یکی از قدرتمندترین زبان‌های برنامه نویسی در سمت سرور است که نمونه بارز قدرت این زبان در سیستم مدیریت محتوای وردپرس کاملا مشخص شده است . کامنت گذاری در این زبان برنامه نویسی بسیار بسیار ساده است اما همانطور که گفته شد مهم اینجاست که شما در چه بخش‌هایی و به چه صورت پروژه را کامنت گذاری و مستندسازی کنید .

روش اول کامنت گذاری در php – تک خطی

درکل شما در زبان‌های برنامه نویسی قادر هستید تا کامنت‌های خود را بصورت تک خطی یا چندخطی تنظیم کنید . اگر قطعه کد یا توضیحات شما تنها در یک خط قرار دارند می‌توانید به سادگی توسط دو حالت زیر کدهای خود را در یک خط کامنت گذاری کنید :

<?php
     // This is a single-line comment
     # This is also a single-line comment
?>

همانطور که می‌بینید در زبان برنامه نویسی php هم با علامت # و هم با علامت // می‌توانید کامنت‌های تک خطی قرار دهید . جالب است اطلاع داشته باشید که به کامنت گذاری با # اصطلاحاً Sell Style گفته می‌شود به این دلیل که این روش از سبک کامنت‌نویسی در شِل لینوکس است . به روش کامنت گذاری توسط // نیز اصطلاحاً C Style گفته می‌شود .

روش دوم کامنت گذاری در php – کامنت‌های چندخطی

اگر نیاز داشته باشید تا چندخط کد پشت سرهم را کامنت کنید ، برای مثال یک بخش از کد که مربوط به یک تابع است و یا توضیحات خودتان جهت خوانایی کد را در چندخط بنویسید ، می‌توانید به روش زیر کامنت گذاری انجام دهید :

/*
    this is a multi-line comment
    this is a multi-line comment
    this is a multi-line comment
    this is a multi-line comment
    this is a multi-line comment
*/

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

درمورد کامنت نویسی دقت داشته باشید که لازم نیست برای موارد مشخص و بدیهی از کامنت گذاری استفاده کنید . برای مثال یک شخص برنامه نویس زبان پی اچ پی ، بخوبی اطلاع دارد که متغیر چگونه و به چه روشی تعریف می‌شود لذا نیازی به کامنت گذاری در این قسمت‌ها نیست . نهایتا یک مورد دیگر در کامنت نویسی با php را خدمتتان معرفی خواهیم کرد .

کامنت‌های PHPDoc

کامنت‌های PHPDoc یکی از زیرشاخه‌های کامنت گذاری چندخطی است که البته این نوع کامنت گذاری بیشتر برای معرفی پارامترهای توابع یا تفسیر کلاس‌ها در برنامه نویسی شی گرا انجام می‌شود . نمونه‌ای از این نوع کامنت گذاری را در بخش زیر مشاهده می‌کنید :

/**
 * this is a PHPDoc comment
 *
 * @param int $number parameter details 
 * @return int return value details 
 */
function add($number) {
  return $number * 2;
}

شاید این روش از کامنت گذاری را در فایل قالب‌های آماده وردپرس بسیار مشاهده کرده باشید . در حقیقت نیز مشاهده می‌کنید که از همان روش کامنت گذاری چندخطی با نشانه‌های * در هر خط استفاده شده است . این مقاله کوتاه و کاربردی برای شما دوستان عزیز با چند اصطلاح جدید که معرفی شده است بسیار مفید خواهد بود . پاینده باشید دوستان من .