آموزش کامنت در PHP – به زبان ساده با مثال و کد

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

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

منظور از کامنت در PHP چیست؟

کلمه «کامنت» (Comment) در لغت به معنای نظر است، ولی در زبان برنامه نویسی PHP کامنت‌ها بخشی از کد هستند که در زمان اجرای برنامه اجرا نمی‌شوند. در واقع، بخش‌های کامنت شده از کد PHP توسط «مفسر» (Interpreter) نادیده گرفته می‌شوند. علاوه بر این، کاربران برنامه نیز قادر به دیدن کامنت‌ها نیستند.

فیلم آموزش برنامه نویسی پی اچ پی PHP در فرادرس

کلیک کنید

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

کاربرد کامنت در PHP چیست؟

در زبان PHP از کامنت برای قرار دادن یادداشت یا توضیحات در کد استفاده می‌شود که به برنامه‌نویس اصلی و سایر افراد کمک می‌کند تا منظور کد را بهتر درک کنند. قرار دادن کامنت در PHP هیچ تاثیری بر عملکرد کلی برنامه ندارد، زیرا کامنت‌ها توسط مفسر PHP اجرا نمی‌شوند. مهم‌ترین موارد استفاده کامنت در PHP به شرح زیر است.

• مستندسازی
• شفاف‌سازی
• اشکال‌زدایی
• بهبود همکاری تیمی
• کنترل نسخه

در ادامه این بخش هر کدام از موارد استفاده ذکر شده در بالا به‌طور کامل توضیح داده خواهد شد.

مستندسازی

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

شفاف‌سازی

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

اشکال‌زدایی

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

بهبود همکاری تیمی

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

کنترل نسخه

کامنت‌‌گذاری در سیستم‌های کنترل نسخه نیز کاربرد دارد. توسعه‌دهندگان می‌توانند از کامنت در PHP برای مشخص کردن تغییرات یا نشان دادن بخش‌های منسوخ شده یا در دست بررسی استفاده کنند.

یادگیری زبان برنامه نویسی PHP با فرادرس چگونه است؟

یادگیری زبان برنامه نویسی PHP دروازه‌ای برای ورود به دنیای توسعه وب محسوب می‌شود. این زبان برنامه نویسی پرتقاضا توسط بسیاری از کسب‌وکارها و شرکت‌های مطرح در سراسر جهان مورد استفاده قرار می‌گیرد. اگر به دنیای برنامه نویسی وب علاقه‌مند هستید، لحظه‌ای در انتخاب و یادگیری زبان PHP درنگ نکنید. خوشبختانه امروزه برای یادگیری هر مهارتی دنیایی از منابع مختلف اعم از آموزش‌های متنی، ویدیویی، مقالات و کتاب‌های آموزشی مختلف پیش روی ما قرار دارد. بنابراین، با توجه به تعداد زیاد گزینه‌ها انتخاب منبع مناسب برای یادگیری نقش بسیار مهمی دارد. بر همین اساس پلتفرم فرادرس به عنوان یکی از بزرگترین سیستم‌های آنلاین آموزشی کشور آموزش‌های پروژه محور و موضوع محور متعددی را در حوزه زبان برنامه نویسی PHP و سایر زبان‌های برنامه نویسی در اختیار علاقه‌مندان قرار داده است.

در گام نخست باید توانایی نصب و راه‌اندازی PHP را داشته باشید و با توابع اصلی موجود در این زبان برنامه نویسی کار کنید. برای شروع می‌توانید فیلم آموزش رایگان آشنایی با PHP فرادرس را مشاهده کنید که لینک آن در ادامه آورده شده است.

• فیلم آموزش رایگان آشنایی با PHP فرادرس

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

• فیلم آموزش برنامه نویسی PHP فرادرس

شیوه های مختلف کامنت گذاری در PHP کدامند؟

کامنت‌ها بخش مهمی از کد هستند که اطلاعات مفیدی را ارائه می‌دهند. برنامه‌نویس و سایر توسعه‌دهندگان با استفاده از کامنت هدف کد را خیلی سریع درک می‌کنند. در زبان PHP شیوه‌های مختلفی برای نوشتن کامنت وجود دارد که توسعه‌دهنده بسته به نیاز خود می‌تواند از آن‌ها استفاده کند. ۲ روش اصلی کامنت‌گذاری در PHP به شرح زیر است.

• کامنت تک‌خطی در PHP
• کامنت چندخطی در PHP

در ادامه این بخش از نوشته هر کدام از شیوه‌های کامنت‌گذاری بالا را همراه با مثال توضیح خواهیم داد.

کامنت تک‌خطی در PHP

کامنت‌های تک‌خطی در PHP برای قرار دادن یک یادداشت‌ کوتاه قبل از بلوک کد یا توضیح یک خط کد مفید هستند. توضیحات یا کامنت‌های تک‌خطی در PHP با دو اسلش روبه‌جلو (// ) مشخص می‌شوند. سپس، بخش مورد نظر قرار داده می‌شود. قطعه کد زیر نحوه کامنت‌گذاری تک‌خطی با این روش را نشان می‌دهد.

1// echo “This will not be printed to the user.”;

روش دیگر برای کامنت تک‌خطی در PHP استفاده از کاراکتر# به دو اسلش روبه‌جلو است. قطعه کد زیر این مورد را نشان می‌دهد.

1# echo “And neither will this.”;

از این سبک کامنت‌گذاری در PHP بیشتر برای ارائه توضیحات مختصر استفاده می‌شود.

کامنت چندخطی در PHP

کامنت‌های چندخطی در PHP به توسعه‌دهندگان امکان می‌دهند چندین خط از کدهای برنامه را به حالت کامنت دربیاورند. توضیحات چندخطی در PHP با قرار دادن کاراکتر/* شروع و با نوشتن*/ به پایان می‌رسند. قطعه کد زیر یک کامنت چندخطی در PHP را نشان می‌دهد.

1<?php
2  /* This is a multiline PHP
3  comment. None of this
4  will be shown to the user. */
5  echo "This message will be printed to the user.";
6?>

توسعه‌دهندگان به منظور قرار دادن توضیحات کامل برای کد خود می‌توانند از این نوع کامنت استفاده کنند. استفاده از این نوع کامنت‌گذاری درک و سازماندهی کدهای برنامه را آسان‌تر می‌کند.

چه نکاتی را در نوشتن کامنت در PHP باید رعایت کرد؟

استفاده از صحیح از قابلیت کامنت در برنامه نویسی نقش بسیار مهمی در مستندسازی موثرتر کد دارد. آشنایی با شیوه صحیح کامنت نویسی در PHP یا هر زبان برنامه نویسی دیگری یک مهارت ضروری محسوب می‌شود که خوانایی و قابلیت نگهداری کد را تا حد بسیار زیادی بهبود می‌بخشد.

فیلم آموزش برنامه نویسی پی اچ پی PHP در فرادرس

کلیک کنید

در ادامه این بخش چند نکته مهم در خصوص نوشتن کامنت در PHP ارائه شده است که رعایت آن‌ها موجب افزایش خوانایی کد می‌شود. به منظور مستندسازی موثرتر کد خود پیشنهاد می‌شود که نکات زیر را هنگام کامنت گذاری رعایت کنید.

مختصر و مفید بنویسید

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

1// Bad comment
2$total = $subtotal + $tax; // Add tax to subtotal
3
4// Good comment
5// Calculate the final total including tax for accurate billing
6$total = $subtotal + $tax;

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

به جای توضیح چیستی به چرایی کد بپردازید

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

1// Use 3600 seconds to convert hours to seconds because we need the time in UNIX timestamp format.
2$seconds = $hours * 3600;

در مثال بالا چرایی وجود این بخش از کد به‌طور کامل توضیح داده شده است.

کد خود را گویا بنویسید که نیاز به کامنت نداشته باشد

هر چند کامنت‌گذاری یک قابلیت بسیار خوب و کاربردی در زبان‌های برنامه نویسی است ولی تا جای ممکن سعی کنید از کامنت کمتر استفاده کنید. برای این منظور پیشنهاد می‌شود در زمان کدنویسی به شکلی متغیرهای برنامه را نام‌گذاری کنید که کد نوشته شده کاملاً گویا باشد. مثال زیر را در نظر بگیرید.

1$is_completed = true;

قطعه کد بالا نیازی به نوشتن کامنت ندارد. اگر متغیر تعریف شده در بالا به شکل زیر نوشته می‌شد آنگاه نیاز به استفاده از کامنت وجود داشت.

1$ic = true; // is completed

بنابراین، سعی کنید کد خود را تا جای ممکن گویا و واضح بنویسید تا نیازی به قرار دادن توضیحات اضافه وجود نداشته باشد.

از اصطلاحات و قالب‌بندی مناسب استفاده کنید

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

عملکرد توابع و کلاس‌های برنامه را به طور کامل شرح دهید

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

1/**
2 * Calculates the area of a rectangle.
3 *
4 * @param float $width  The width of the rectangle.
5 * @param float $height The height of the rectangle.
6 * @return float       The area of the rectangle.
7 */
8function calculateArea($width, $height) {
9    return $width * $height;
10}

در مثال بالا با استفاده از کامنت‌گذاری در PHP عملکرد تابع به‌طور کامل توضیح داده شده است.

از کلمه TODO در مواقع لازم استفاده کنید

اگر بخش‌هایی از کد برنامه به بهبود نیاز دارند یا ناقص هستند، می‌توانید از کلمهTODO در نوشتن کامنت استفاده کنید تا در بازگشت دوباره شما به کد یادآوری در خصوص تکمیل این بخش‌ها صورت گیرد.

1// TODO: Refactor this function to improve performance

کامنت های خود را به‌ روز نگه دارید

در صورت انجام تغییرات یا ویرایش کد برنامه سعی کنید کامنت‌های قبلی خود را به به‌روزرسانی کنید. کامنت‌های منسوخ شده بیشتر از اینکه مفید باشند می‌توانند تاثیر منفی داشته باشند.

1// Before:
2// This function fetches user data (it was previously fetching from the old API)
3
4// After migrating to the new API:
5// This function fetches user data from the new API end-point.

برای توضیحات کامل از کامنت های چندخطی استفاده کنید

به منظور ارائه توضیحات کامل پیشنهاد می‌شود تا از کامنت‌های چندخطی در PHP برای حفظ وضوح و خوانایی کد استفاده کنید.

1/*
2 * This function performs validation on user input.
3 * It checks for presence, length, and specific patterns.
4 * If the input is invalid, it triggers an error.
5 */
6function validateUserInput($input) {
7    // validation logic here...
8}

تقویت برنامه نویسی PHP با فرادرس

بعد از تسلط کافی به مباحث و اصول پایه موجود در زبان برنامه نویسی PHP باید با انجام تمرین‌ها، پروژه‌ها و مثال‌های مختلف توانمندی خود در این زبان را بهبود بخشید. پروژه‌ها و تمرین‌ها متعددی برای ارتقا سطح دانش و مهارت شما در زبان PHP وجود دارد. به عنوان مثال با استفاده از PHP و سایر تکنولوژی‌های حوزه وب نظیر HTML، CSS و جاوا اسکریپت می‌توانید سایت‌های مختلفی را پیاده‌سازی کنید. در پلتفرم فرادرس آموزش‌های پروژه محور متعددی در حوزه زبان برنامه نویسی PHP منتشر شده است. با استفاده از این آموزش‌ها نحوه پیاده‌سازی و راه‌اندازی یک پروژه واقعی را در عمل خواهید آموخت.

برای دسترسی به مجموعه فیلم‌های آموزش برنامه نویسی PHP فرادرس می‌توانید از لینک زیر استفاده کنید.

• مجموعه فیلم‌های آموزش برنامه نویسی PHP فرادرس

در ادامه تعدادی از دوره‌های پیشنهادی موجود در این مجموعه آموزشی آورده شده است.

• فیلم آموزش پروژه محور ساخت وبلاگ شخصی با PHP فرادرس
• فیلم آموزش پروژه محور ساخت وب‌سایت شعر با PHP و MySQL فرادرس
• فیلم آموزش پروژه محور ساخت موتور جستجو برای وب سایت با PHP فرادرس
• فیلم آموزش پروژه محور ساخت ربات و تبدیل آن به شخص واقعی با PHP فرادرس
• فیلم آموزش پروژه محور طراحی سایت فروشگاهی با PHP فرادرس

جمع‌بندی

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

فیلم مجموعه آموزش‌ برنامه نویسی پی اچ پی PHP – مقدماتی تا پیشرفته در فرادرس

کلیک کنید

علاوه بر این، شیوه‌های مختلف کامنت‌گذاری در PHP به همراه مثال بیان شد. در ادامه نیز نکات مهمی عنوان شد که هنگام نوشتن کامنت در PHP باید رعایت کرد.