Как закомментировать PHP

Как закомментировать PHP

Как закомментировать на время код HTML, CSS или PHP, JS

…сегодня мы в этой коротенькой, но полезной статье, разберемся, как же комментируется различный программный код. Много говорить не стану, ибо если вас подобное заинтересовало, то вы уже столкнулись с вопросами этой задачи, и представление о ней имеете.

Также о представлении можно прочесть предыдущую статью Оформление внешних и внутренних ссылок визуальными иконками CSS

Вы зашли по адресу… но несколько слов для ясности и пользы дела. Наверняка видели, как это делается с CSS-кодом, так как сss представляет наибольший интерес у многих начинающих, как и я.

… Хорошо!

Но обратите внимание, что комментарии используются также и в html и php… А ведь большинство начинающих путаются на начальном этапе своей работе с сайтом и не знают, как дописать себе необходимые пояснения. Ведь бывает же так, например, вам потребуется на какое-то время деактивировать код html, а потом снова возобновить его функцию — это запросто реализовать, если вы сделали себе пометки на «полях», да мало ли что.

Но что следует помнить о «комментариях» вообще — тут всё в строгой зависимости от того, с каким файлом вы работаете конкретно, а следовательно и код применения различен.

Итак:

Комментируем код HTML

<!— <div class=»redblock»><p>This is some HTML in the redblock class.</p></div> —>

Аналогично комментируется и файл XML

<!— закрытый код …код —>

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

Обычная невнимательность при форматировании может стоить времени, например, показанный выше ЗАКОММЕНТИРОВАННЫЙ код частенько бывает ошибочен: заместо двух коротких дефисов вырисовывается длинное тире:

<!— закрытый код …код —>

К сведению же:

как говорилось в предыдущей ремарке — так же и закомментный… код html отображается в сгенерированном документе!

Имейте в виду это.

И вот ещё что:

помимо того, что комментированный код отображается в исходном коде страницы (а значит и отрабатывается в каком-то смысле, хотя и на страничке будет невидим!) — какие-то функции php связкой с html лучше выносить из активного документа.

Например:

<!—<br /><div class=»postmeta»><?php echo category_description(); ?></div>—>

будет виден в документе и функция <?php echo category_description(); ?> замечательно отработает своё дело: т.е во фронтенде информации станет не видать, но вот в исходнике — она чётко отобразится! и это беспонтовый запрос к БД: всё это мелочь, но знать надобно!

Возможно поступить так, если выносить кусок кода из документа не хочется:

добавьте перед необходимым «лишним» html кодом открывающий <?php и ?>… встроенная функция… и закрывающий ?>…

Словом, вот так можно поступить, если код большой:

<?php /** ?><br /><div class=»postmesy»><?php echo category_description(); ?></div> **/ ?>

тогда исходник будет чистеньким!

Или попроще:

<?php /** echo category_description(); **/?>

Закомментируем саму функцию в документе html. Исходник в этих случаях относительно отработок функций будет чистеньким!

Комментируем код PHP

<?php else : // get_template_part(‘post’, ‘noresults’); endif;

…и …здесь аналогично – слеш-слеш… однострочный.

Но обратите внимание, что его можно комментировать так, как и код-CSS.

…либо так можно закомментировать — однострочный вариант, когда используем НЕ ДВА СЛЕШ, но БЕКАР (решётка) перед комментируемой строкой:

<?php else : # get_template_part(‘post’, ‘noresults’); endif;

…Естественно, комментировать нужно осторожно в цикле кода!

…либо же таким образом — аналогично показанному выше примеру для CSS… т.е. этот /* код */ вариант комментирования подойдёт и для CSS и для JS кодов !

<?php else : /* get_template_part(‘post’, ‘noresults’); */ endif;

А вот таким образом можно закомментировать более объёмное пояснение к коду PHP, где-то меж его основными примерами…

<?php /** * The default post formatting from the post.php template file will be used. * If you want to customize the post formatting for your homepage: * * — Create a new file: post-homepage.php * — Copy/Paste the content of post.php to post-homepage.php * — Edit and customize the post-homepage.php file for your needs. * * Learn more about the get_template_part() function: http://codex.wordpress.org/Function_Reference/get_template_part */

Ещё в циклах php можно комментровать и так, коли код смешанный… php и как-то html

Аналогично описанному выше:

К примеру какая-то такая функция… где-то в общем коде (или цикл в html): <?php mihalica_add_viva(); ?> — можно закомментировать, т.е добавить свою метку так:

<?php /** или тут **/ mihalica_add_viva(); /** или так: здесь можно поместить целый цикл какой-то функции — она будет неактивна! **/ ?>

или так: однострочный вариант…

<?php // mihalica_add_viva(); — однострочный (до переноса строки) /** или так: здесь можно помести целый цикл какой-то добавочной функции — *…она будет неактивна! **/ ?>

Сведения:

php код не виден ни в каких исходных кодах!! виден только его функциональный результат — отработка!

Вот в общем и всё что хотелось нынче доложить!

Главная » Основы PHP » Комментарии в php коде и как закомментировать код. Основы PHP с нуля. Урок №4
25.04.2017
14:17
7689
4

PHP комментарий коде

Существует 2 вида комментариев для кода PHP:

→ однострочный
→ многострочный
⇒ Однострочный комментарий для PHP
Для однострочного комментария следует применять символы «//» или «#»

После этих символов все, что записано в одну строку будет игнорироваться и считаться как комментарий.

Пример:

<?php // Однострочный комментарий для PHP # Однострочный комментарий для PHP (можно и так) echo «Привет читателям блога — StepkinBLOG.RU!!!»; // Мое приветствие (это комментарий) echo «<br />Подпишись на обновление»; # подписка (это комментарий) ?>

На экране вы только увидите вот такой текст:

Привет читателям блога — StepkinBLOG.RU!!!
Подпишись на обновление

⇒ Многострочный комментарий для PHP
Многострочный комментарий для PHP начинается с символа «/*» и заканчивается символом «*/».
Все, что находится между этими символами, будет игнорироваться и считаться как комментарий.
Многострочный комментарий используется, если в записи несколько строк.

Пример:

<?php /* Многострочный комментарий для PHP. Многострочный комментарий используется, если в записи несколько строк. */ echo «Привет читателям блога — StepkinBLOG.RU!!!»; ?>

На экране вы только увидите вот такой текст:

Привет читателям блога — StepkinBLOG.RU!!!

P.S.: Всегда комментируйте свой код. Если вы считаете, что вспомните все, что делали в коде через 1-2 года, вы ошибаетесь, шанс очень маленький. Даже если и вспомните, то придется потратить кучу времени на изучение – что, куда и зачем…
Сделайте приятное для себя будущего – закомментируй код и ты сам себе потом скажешь «СПАСИБО!!!».
Оставь комментарий в коде, это займет 1 минуту времени, но сэкономит тебе в будущем целый день.


Добавить комментарий

Ваш e-mail не будет опубликован. Обязательные поля помечены *