Здравствуйте, уважаемые посетители!
В сегодняшней статье я хотела бы вам рассказать, как можно делать в html комментарии в коде, а так же в css-стилях и php-файлах.
Навигация по статье:
Для чего нужно оставлять комментарии в коде?
Привычка оставлять пометки и пояснения в коде – это одна из самых полезных привычек программиста или веб-разработчика! Так как это позволяет, во-первых вам самим лучше и быстрее ориентироваться в своём файле, а во-вторых если вы работаете в команде или планируете передавать проект на доработку – то комментарии в html-коде – это незаменимая вещь.
Кроме того это пригодиться вам, в случае если вам нужно какой-то фрагмент кода временно убрать, например, отключить какие-то css-стили, или убрать определённый элемент на html-странице.
Получается, что такая мелочь как умение правильно расставлять комментарии в коде, позволит вам сэкономить много времени и нервов и привести его в более опрятный и понятный вид.
HTML-комментарии в коде
Для комментирования в HTML используется следующая запись:
|
1 |
<!--Тело комментария --> |
Если вам нужно сделать пометку или обозначить какую-то область в html-файле, то html комментарии в коде будут выглядеть следующим образом:
|
1 2 3 4 5 |
<!— Начало формы обратной связи --> <div class=”contact-form”> … </div> <!— Конец формы обратной связи --> |
Если же вам нужно исключить какой-то элемент на странице, то html комментарии в коде нужно поставить следующим образом:
|
1 2 3 4 5 |
<!-- <div class=”block”> …Код блока… </div> --> |
В данном случае обернутый в фрагмент html преобразуется в комментарий и исключается из работы.
Комментарии для css-стилей
CSS-комментарии делаются немного по другому:
|
1 |
/* … */ |
Так же, как и для HTML если вам нужно пометить какую-то область или сделать какое-то пояснение, то можно поставить css-комментарий рядом со стилями, перед ними, или после:
|
1 2 3 4 5 |
/*Стили для формы обратной связи*/ .contact-form{ display:none!importan; /* Скрываем элемент с классом contact-form */ } /*Конец стилей для формы*/ |
А если нужно отключить какие-то стили, то просто оборачиваем их в комментарий:
|
1 2 3 4 5 |
/* .class{ … } */ |
Комментирование в PHP
Для PHP комментарии и правила их использования так же отличаются. Так если вам нужно закомментировать какую-то одну строку или сделать пометку в теле фрагмента кода, то вам нужно использовать двойной слэш (//). Например:
|
1 2 3 4 5 6 7 |
<?php if (is_front_page() ) { echo('<style>…</style>'); // действие для главной страницы } else { echo('<style>…</style>'); // действие для не главной страницы } ?> |
Если же вам нужно закомментировать несколько строк, то для этого можно использовать символы для комментирования /* и */, такие-же как для css-стилей, но с одним отличием:
|
1 2 3 4 5 6 7 8 |
<?php /* if( is_page_template( 'page-templates/contact.php' ) ) { $sidebar = 'colornews_contact_page_sidebar'; } else { $sidebar = 'colornews_right_sidebar'; } */ ?> |
Сегодня я вам показала все основные способы комментирования для HTML, CSS и PHP которые вы можете использовать при создании сайтов. Даже более того, я бы вам советовала выучить их и использовать как можно активнее. Так как с таким кодом, в котором строки имеют пояснения и сам код структурирован с использованием комментариев, намного проще разобраться.
Очень надеюсь, что моя статья будет для вас полезна. Не забывайте оставлять комментарии и делиться статьей в социальных сетях.
А у меня на сегодня все. До встречи в следующих статьях!
С уважением Юлия Гусарь
Взял за правило комментировать те места в коде, которые могут легко забыться со временем. Обычно пишу темы под вордпресс под заказ, а когда через несколько месяцев клиент просит что-то добавить, то начинаешь там как беспамятный, шарить мышкой и вспоминать, что это такое.
Знакомая ситуация))
Очень полезная информация, спасибо
И Вам спасибо за комментарий!