5 Коментарі
Коментарі - пояснення до початкового тексту програми, що знаходяться безпосередньо усередині коментованого коду. Синтаксис коментарів визначається мовою програмування. З точки зору компілятора або інтерпретатора, коментарі - частина тексту програми, що не впливає на її семантику. Коментарі не мають жодного впливу на результат компіляції програми або її інтерпретацію. Крім вихідних текстів програм, коментарі також застосовуються в мовах розмітки та мовах опису. Більшість фахівців сходяться на думці, що коментарі повинні пояснювати наміри програміста, а не код; те, що можна виразити мовою програмування, не повинно виноситися в коментарі. Зокрема необхідно розбивати програму на легкі для розуміння частини, прагнути до того, щоб структура класів і структура баз даних були максимально зрозумілими і прозорими. Є навіть думка (його дотримуються в екстремальному програмуванні та деяких інших гнучких методологіях програмування), що якщо для розуміння програми потрібні коментарі - значить, вона погано написана. Концепція грамотного програмування наполягає на включення в текст програми настільки докладних і продуманих коментарів, щоб вона стала вихідним текстом не тільки для виконуваного коду, але і для супровідної документації. Коментарі в PHP можуть бути як однорядкові так і багаторядкові. Однорядкові коментарі починаються із "//" або "#" (коментар скриптових мов UNIX). Багаторядкові коментарі починаються символами "/*" і закінчуються "*/" (без лапок). Слід зазначити, що однорядкові коментарі йдуть до кінця поточного рядка або завершального тега. Нижче наведений приклад скрипта із різними видами коментарів:
<?php echo "Це тест" ; // Це однорядковий коментар в стилі C++ /* Це багаторядковий коментар ще один рядок коментарю */ echo "Це ще один тест" ; echo "Останній тест" ; #Це коментар в стилі оболонки Unix ?>
Не можна вкладати один в одний багаторядкові коментарі (вони можуть з’явитися під час коментування великих блоків). Наприклад:
<?php /* echo "Це тест"; /* Цей коментар викличе проблему */ */ ?>
Однорядкові коментарі йдуть тільки до кінця рядка або поточного блоку PHP-коду, в залежності від того, що йде перед ними. Це означає, що HTML-код після "//?>" не буде сприйматись інтерпретатором PHP в якості закінчення коду, як це, можливо, очікувалось від "?>", тому що всі символи до кінця рядка, що йдуть після "//", вважаються коментарем.