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

закомментировать строку с HTML

Приветствую, всех читателей — Sozdaiblog.ru!

Представляю Вашему вниманию мини пост, в котором я покажу, как закомментировать HTML, PHP, CSS строчки кода.

Для начала, немного вводной информации.

Закомментировать HTML код, означает, его временное отключение.

Чтобы Вам было более понятно о чём вообще идёт речь, приведу один из примеров использования этой функции.

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

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

Чтобы избежать ненужных проблем, достаточно закомментировать HTML, PHP, CSS строчки кода и спокойно удалиться по своим делам. Благодаря этой функции, куски кода останутся на месте, а посетители раньше времени ничего не увидят.

Как закомментировать HTML, PHP, CSS.

Для того, чтобы закомментировать HTML строчки кода, оберните их символами – «<!--КОД-->».

Пример:

<!--< div class="widget">
< h3>Лучшие комментаторы блога< /h3>
< /div>-->

Закомментировать PHP, можно, используя символы – «/*  и  */».

Пример:

< ?php /* top_commentator(); */?>

В случае с CSS, применяются те же символы, что и у PHP — «/*  и  */».

Пример:

/* #optin input[type="submit"] {
            background: #960e17;
            border: 1px solid #111 } */

По возвращению к редактированию Ваших файлов, просто удалите поставленные символы и спокойно занимайтесь новыми разработками.

Возможно, что Вас ещё заинтересует:

Надеюсь, что Вам была полезна информация о том, как закомментировать HTML!

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

На сегодня это всё. До новых статей.

С уважением, Денис Черников!

Комментировать нужно не всегда именно код, часто нужно закомментировать подсказку, чтобы легко найти нужную строку в будущем.

Комментировать код в CSS

/* Закомментированный код */

Примеры:

КОММЕНТИРОВАТЬ КОД В CSS

КОММЕНТИРОВАТЬ КОД В CSS

Комментировать код в HTML

<!-- Закомментированный код -->

Примеры:

КОММЕНТИРОВАТЬ КОД В HTML

КОММЕНТИРОВАТЬ КОД В HTML

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

// Закомментированный код

/* Закомментированный код */

Примеры:

КОММЕНТИРОВАТЬ КОД В JAVASCRIPT

КОММЕНТИРОВАТЬ КОД В JAVASCRIPT

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

// Закомментированный код

/* Закомментированный код */

Примеры:

КОММЕНТИРОВАТЬ КОД В PHP

КОММЕНТИРОВАТЬ КОД В PHP

Надо отметить, что двойной слеш // комментирует только строку.

Если использовать специальный редактор Notepad ++, тогда закомментированный код окрасится в зеленый цвет. Это очень удобно!

На заметку: JavaScript - независимый язык программирования, со своей спецификацией ECMAScript, и к Java не имеет никакого отношения.

Всем удачи и добра!

Это вещь достаточно распространенная и известная,

я всего лишь расскажу о ее синтаксисе и применении на практике.

Все будет приминительно ООП на PHP.

Сразу оговорюсь, формат применим к классам, их методам и свойствам,

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

а красиво написаную документацию, этот формат следует применять.

Практика

Итак, пример:

На первый взгляд смотрится не так уж красиво, но есть ряд преимуществ.

Главное преимущество — стандарт. Теперь о приятностях которые дают нам Zend и Eclipse:

В виде hint-подсказки среда разработки показывает нам развернутое описание функции,

где видно какого формата должны быть входные данные и что мы получим в итоге. «Но это еще не все ©»,

существуют системы автоматического создания документации,

и с их помощю можно получить полное описание нашего проекта,

основываясь только на описанных выше комментариях. Как это примерно выглядит:

эта страничка сгенерирована системой phpDocumetor встроенной в ZDE.

Синтаксис комментариев

Синтаксис для функции или метода

/**

* Имя или краткое описание (класса, метода, свойства, функции)

*

* Развернутое описание

* в несколько строк

*

* @имя_тега значение

*

return

тип_данных

*/

Синтаксис для свойства

/**

* Описание

*

*

var

тип_переменной

*/

И на последок список тегов с описанием:

  • @access [private | protected | public] (Контроль доступа для элемента)
  • @author Антонов А. <[email protected]> (Автор текущего элемента)
  • @param тип_данных $имя_переменной Описание (Описание для входного параметра)
  • return тип_данных Описание (Описывает тип возвращаемых данных функцией или методом)

Полный список на

phpDocumentor Manual

.

Комментировать свой код — это полезно не только для себя в будущем, но и для других кодеров, которые буду разбираться с вашим кодом. Комментарии могут убрать множество вопросов к самому программисту, так как многое уже объяснено. И PHP, как и многие другие языки, также имеет комментарии. И в данной статье мы подробно разберем, как комментировать на этом языке.

Введение

Комментарии на php схожи с комментариями на html. Если ввести определенные символы в определённой последовательности, а потом написать программу после этих символов, то интерпретатор просто не прочитает это, так как он знает, что это лишь комментарии. Такая же работа и во многих других языках. Поэтому для того, чтобы просмотреть комментарии нужно посмотреть сам код программы.

Уже было сказано, что php-комментарии похожи на html-комментарии. Но вот как выглядят комментарии, на самом html.

Комментарии в PHP

Однострочные комментарии

На html всего один тип комментариев, в то время как на php их два:

  • однострочный
  • многострочный

Сперва поговорим об однострочном типе. Интерпретатор будет игнорировать всё, что находится после специальных символов в области одной строки. Этими специальными символами являются “//” или “#”. После них идёт лишь текст незначащий ничего для интерпретатора. Если пишете код не в блокноте, то комментарии будут иметь серую окраску.

Комментарии в PHP

Результат:

Комментарии в PHP

Стоит обратить внимание, что некоторые команды, как на 2-ой строке echo не работает, потому что была закомментирована. Так тоже иногда делают для отладки, когда строку нужно временно удалить.

Многострочные комментарии

В html есть только многострочные комментарии. И хоть html, это не язык программирования, но работает всё по тому же принципу. Есть 2 символа: один — открывающий комментарий, другой — закрывающий комментарий. В PHP такими символами является слэш со звёздочкой:

  • /* — открывает
  • */ — закрывает

Комментарии в PHP

Результат:

Комментарии в PHP

Ну и понятное дело, оба типа комментариев можно совмещать:

Комментарии в PHP

Результат:

Комментарии в PHP

Много комментариев — плохо

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

Код, в котором не будет ничего лишнего будет понятен и без комментирования.

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

Принцип комментирования

Как и было сказано, много комментариев не значит хорошо. Но важно в них прояснить несколько вещей:

  • архитектура
  • использование функций
  • рациональность

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

Комментарии в CSS

Во всём семействе C комментарии не отличаются. И хотя CSS не язык программирования он имеет точно такой же вид и такое же обозначение комментариев.

Для обозначения больших кусков кода используются слэши со звёздочкой:

  • многострочные комментарии — /* */
  • однострочные комментарии — //

Как видите, от php ничем не отличается.

Итог

Комментарии — это полезная вещь в языках программирования, хотя она есть и не только там, ещё например и в html с CSS.

Они упрощают жизнь программистов тем, что можно объяснить сложные блоки кода. Но комментировать свой код в каждом моменте — это плохо. Если код и без того понятен, то смысла в этом нет, в противном случае нужно просто его переделать.

Сам способ выражения комментариев не отличается друг от друга в разных языках программирования. Поэтому узнав комментарии в языке C++ — узнал комментарии во всём семействе C.

На этом всё, огромное спасибо за внимание. Интересных проектов и хорошего настроения!

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

Также о представлении можно прочесть предыдущую статью Оформление внешних и внутренних ссылок визуальными иконками 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 таким способом можно, но !! тогда придётся убрать повторные комментарии /*ПОДЧЁРКИВАНИЕ ВНИЗУ*/, или поиграть слэшами, если пояснение важно ))

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

Ко сведению:

Если открыть исходный код страницы — Ctrl+U и взглянуть… то увидим, что закомментированный кусок кода css замечательно отображается в сгенерированном документе! это если css использовалось (задавались свойства) прямо в html

И, как понимаете, если перейти из исходного кода по ссылке в документ css вашего активного шаблона — все комментарии можно наблюдать и изучать)) если кому-то потрэбу. Но это вряд ли)

Английское наречие (слова) будут читаемы. Русская символика — нет.

к оглавлению

Комментируем код 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. Исходник в этих случаях относительно отработок функций будет чистеньким!

к оглавлению

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

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

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

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

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

ремарка:

если кто-то перейдёт по ссылке в исходном коде шаблона «в документ» js, всякие личные комментарии будут видны в соответствии с кодировкой (транслитерация описана выше)

к оглавлению

Комментируем код 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;

комментируем код js php css

А вот таким образом можно закомментировать более объёмное пояснение к коду 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 код не виден ни в каких исходных кодах!! виден только его функциональный результат — отработка!

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

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

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

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

подписка feedburner Online консультация по работе c сайтом на WordPress

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

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

...вопросы в комментариях - помогу, в чём дюжу... mihalica.ru !

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