Учебник PHP: Урок 7: Комментарии в скриптах

Как вы могли заметить, PHP-скрипты могут выглядеть непонятно. В этом уроке мы выясним, почему комментарии так важны, и как вставить их в ваши скрипты.

Почему комментарии так важны для ваших скриптов?

Когда вы кодируете, вы пишете команды серверу/компьютеру и должны использовать весьма формальный язык, который может не вполне понятно отражать ход ваших мыслей при написании скрипта.

Следовательно, другим людям (или вам самим) может быть трудно понять структуру скрипта, и, соответственно, трудно идентифицировать и корректировать ошибки.

С помощью комментариев можно вставлять в скрипт краткий пояснительный текст. Сервер полностью игнорирует комментарии, и они не влияют на функциональность самогó скрипта.

В бизнес-среде часто предъявляется требование, чтобы скрипты и программы комментировались, иначе существует риск, что компания примет систему, в которой слишком сложно будет находить и устранять ошибки.

Как вставлять комментарии?

Это весьма просто. Комментарий начинается двойным слэшем: "//".

См. этот пример из урока 5, теперь с комментариями:

 <html>
 <head>
 <title>Циклы</title>
 </head>
 <body>

 <?php

 // Здесь записываем коды цвета с использованием трёх циклов

 // Red может быть в диапазоне от 0 до 255 
 for ($intRed=0; $intRed<=255; $intRed=$intRed+30) {

    // Green может быть в диапазоне от 0 до 255
    for ($intGreen=0; $ intGreen<=255; $intGreen=$intGreen+30) {

       // Blue может быть в диапазоне от 0 до 255
       for ($ intBlue=0; $intBlue<=255; $intBlue=$intBlue+30) {

       // Код цвета образуется в форме rgb(red,green,blue)
    $strColor = "rgb(" . $intRed . "," . $intGreen . "," . $intBlue . ")"

       // Теперь записываем код цвета  для клиента
    echo "<span style='color:" . $strColor . "'> " . $strColor . " </span>";

       // Закрываем циклы
       }
    }
 }

 ?>