التعليقات على الأكواد في بي اتش بي PHP Comments تعد من أهم أدوات المبرمج، فلابد من وضع الملاحظات على الأكواد لتسهيل عملية مراجعة الأكواد سواء من قبل المبرمج نفسه أو من سيقوم بقراءة الكود من بعده. وهذه التعليقات لن تظهر لمستخدمي التطبيق على عكس تعليقات اتش تي ام ال HTML Comments

تعليق السطر الواحد

فأحياناً يكون التعليق مجرد ملحوظة صغيرة لن تحتاج أكثر من سطر واحد، فيتم كتابة التعليق باستخدام علامة // أو #، فيقوم مُنفذ PHP بتجاهل هذا الكود.

<?php //This is a simple echo echo 'Hi there'; //echo 'Hello friends'; #echo 'Hello friends' ?>

ففي الكود السابق لن يتم طباعة سوى السطر رقم 3 أما جملة  echo في السطر رقم 4 , 5  لن يتم تنفيذها لأنها مجرد تعليق.

التعليق متعدد الأسطر

لكن أحياناً تحتاج لإضافة تفاصيل أكثر في أكثر من سطر، بحيث تم وضع مجموعة الأسطر داخل علامة /**/، فمثلاً هذا تعليق متعدد الأسطر من قالب ووردبريس

/* Theme Name: Twenty Seventeen Theme URI: https://wordpress.org/themes/twentyseventeen/ Author: the WordPress team Author URI: https://wordpress.org/ Description: Twenty Seventeen brings your site to life with header video and immersive featured images. With a focus on business sites, it features multiple sections on the front page as well as widgets, navigation and social menus, a logo, and more. Personalize its asymmetrical grid with a custom color scheme and showcase your multimedia content with post formats. Our default theme for 2017 works great in many languages, for any abilities, and on any device. Version: 1.1 License: GNU General Public License v2 or later License URI: http://www.gnu.org/licenses/gpl-2.0.html Text Domain: twentyseventeen Tags: one-column, two-columns, right-sidebar, flexible-header, accessibility-ready, custom-colors, custom-header, custom-menu, custom-logo, editor-style, featured-images, footer-widgets, post-formats, rtl-language-support, sticky-post, theme-options, threaded-comments, translation-ready This theme, like WordPress, is licensed under the GPL. Use it to make something cool, have fun, and share what you've learned with others. */

فجميع هذه الأسطر لن يتم تنفيذها ولكن هي مجرد مجموعة معلومات مفيدة.

أهمية التعليقات في البرمجة

لنتخيل أنك قمت ببرمجة موقع إلكتروني لأحد العملاء، ثم بعد فترة كبيرة طُلب منك دعماً فنياً لهذا الموقع، فهل ستتذكر فيما كنت تفكر تحديداً في هذا الوقت، أو ربما هذا الشخص لديه بعض المعلومات التي يستطيع من خلالها حل مشكلته ولكن لايعرف ميكانيكية عمل الكود فلايصل للحل إلا بعد معاناه أو قد لايصل، لذا لابد من وضع علامات إرشادية دائماً على الطريق لتسهيل الوصول للهدف.