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

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

 

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

 

(в финале статьи подробное видео о правилах и способах комментирования кодов)

 

 

 

 

 

 

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

 

 

… Хорошо!

 

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

 

 

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

 

 

 

ошибки в комментариях к коду – по версиям php

 

 

 

php 8

 

 

 

 

Как известно, не так давно вышла версия php 8 – некоторые пользователи столкнулись с проблемами!

 

В данной статье коснемся, скажем так, синтаксиса – правописания))…

 

 

Например, если комментируете в самом финале кода, то обязательно соответственно закрывайте комментарий! иначе, в новейших версиях php (подобные правила касаются многих ЯПов) бесконечно закомментированный блок вызовет ошибки! Белый экран.

 

 

 

 

 

 

 

 

…далее: никогда не ЛЕПИТЕ друг к дружке символы комментариев к тегам кода!!!! неряшество в коде, как и в жизни, вызывает неприличные ошибки.

 

 

На мой взгляд, лучше потратить несколько лишних минут времени, но написать чистенький и аккуратный код и комментарии. Это в будущем сэкономит массу времени!

 

 

неправильно:

 

<?php/*коммент*/?>

 

 

правильно:

 

<?php /*коммент*/ ?>

 

 

 

 

…продолжаем о правилах комментирования кода…

 

 

Итак:

 

 

 

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

 

 

 

a:hover, a:focus {
color: #D5071E;
text-decoration: Overline; /*ПОДЧЁРКИВАНИЕ ВВЕРХУ*/
}

 

 

 

Таким образом вы делаете себе пояснение. Или можно вообще закомментировать этот скрипт css так: просто оберните

 

/* здесь КОД */

 

 

 

/*a:hover, a:focus {
color: #D5071E;
text-decoration: underline; /*ПОДЧЁРКИВАНИЕ ВНИЗУ*/
}*/

 

 

Обращаю ваше внимание на то, что – закомментировать полный цикл кода css таким способом можно, но !! тогда придётся убрать повторные комментарии /*ПОДЧЁРКИВАНИЕ ВНИЗУ*/, или поиграть слэшами, если пояснение важно ))

 

Иначе будет ошибка!!

 

 

 

 

 

 

 

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

 

 

 

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

 

 

 

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

 

 

 

<!-- закрытый код ...код -->

 

 

 

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

 

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

 

 

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

 

 

 

 

 

 

 

И вот ещё что:

помимо того, что комментированный код отображается в исходном коде страницы (а значит и отрабатывается в каком-то смысле, хотя и на страничке будет невидим!) – какие-то функции 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. Исходник в этих случаях относительно отработок функций будет чистеньким!

 

 

 

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

 

 

 

 

if (beingShown || shown) {
// don't trigger the animation again
return;
} else {
// в строке применяем ЛЮБОЙ КОММЕНТАРИЙ
// в строке применяем ЛЮБОЙ КОММЕНТАРИЙ
// true;

 

 

 

Этот пример-код JavaScript, — я, для наглядности, ухватил в нете, слегка поправив пунктуацию. Это неважно… Главное понять принцип…

 

Как вы понимаете слеш «//» двойной, это и есть ЗНАК комментария… ОДНОСТРОЧНЫЙ !

 

 

А в остальном код JS комментируется подобно php, об этом ниже:

 

 

 

 

 

 

Комментируем код 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(); - однострочный (до переноса строки)

/** или так: здесь можно помести целый цикл какой-то добавочной функции -

*...она будет неактивна! **/

?>

 

 

 

 

 

 

 

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

 

Теперь можете поэкспериментировать… Удачи.

 

 

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

...город веб мастеров Михалика.ru © - запросто с WordPress - ATs media squad

 

 

Online консультация по настройкам и созданию сайтов на WordPress

 

 

 

Подробная видеоинструкция: