Как делать комментарии в коде?
В сегодняшней статье я хотела бы вам рассказать, как можно делать в html комментарии в коде, а так же в css-стилях и php-файлах.
Навигация по статье:
Для чего нужно оставлять комментарии в коде?
Привычка оставлять пометки и пояснения в коде – это одна из самых полезных привычек программиста или веб-разработчика! Так как это позволяет, во-первых вам самим лучше и быстрее ориентироваться в своём файле, а во-вторых если вы работаете в команде или планируете передавать проект на доработку – то комментарии в html-коде – это незаменимая вещь.
Кроме того это пригодиться вам, в случае если вам нужно какой-то фрагмент кода временно убрать, например, отключить какие-то css-стили, или убрать определённый элемент на html-странице.
Получается, что такая мелочь как умение правильно расставлять комментарии в коде, позволит вам сэкономить много времени и нервов и привести его в более опрятный и понятный вид.
Как закомментировать часть кода в html
Пока я творю, я живу!
Блог посвящен: HTML, CSS, PHP, WordPress, Bootstrap
Комментировать код в HTML. Что это и зачем нужно…
Всем привет!
Мне, как разработчику сайтов, скриптов и плагинов, часто помогают мои закомментированные подсказки в самом коде. Комментировать код нужно в любом случае, или вы пишите код сами, либо пишите его целой командой.
Итак, что значит закомментировать код в HTML?
— дать ориентир в HTML коде
— сделать подсказку
— оставить инструкцию
— временно отключить части HTML кода (об этом чуть позже).
Значит, цель комментариев в коде – подсказать или напомнить, где и какая часть кода что выполняет.
Кстати, комментарии не видны в браузере, а только если посмотреть в исходный код.
Чтобы оставить комментарий в коде, используют тег:
<!— (открываем тег для комментария)
—> (закрываем тег для комментария).
Все что находится внутри, это будет комментарий к коду. Смотрим пример:
Теперь, если через год вам нужно будет где-то что-то подправить на сайте, вы долго разбираться не будете, так как умеете комментировать в HTML коде.
Помните, я в самом начале статьи написал: «- временное отключение части HTML кода (об это чуть позже)»?
Так вот, я частенько пользуюсь комментариями, чтобы временно закомментировать какую-то часть кода.
Вот, например, сейчас вам блок для рекламы не нужен, но в будущем вы хотите, чтобы он отображался на сайте. Чтобы не удалять блок и потом снова не тратить время на их восстановление, достаточно просто закомментировать. Смотрим пример, как я закомментировал картинку «heder.png»:
Это все! Всегда комментируйте то, что пишите в коде, так как голова не чемодан – все не уложишь. В нашем случае лучше потратить секунду на написание комментария, чем потом потратить час, чтобы вспомнить, что это вы в коде сделали.
HTML Комментарии
HTML комментарии используются для написания пояснений, напоминаний или дополнительных описаний к отрезкам HTML кода. Они облегчают работу с кодом, позволяют быстро найти необходимые части, а также разобраться в намерениях программиста, который писал код (особенно важно, когда над созданием веб-сайта работают несколько человек).
Комментарии также можно использовать для временного исключения какого-либо блока, не удаляя его. Надо лишь поместить этот отрезок в тег <!— . —>, и браузер не будет его отображать. Сами комментарии в браузере не показываются, однако их можно увидеть, просмотрев исходный код веб-страницы.
Синтаксис
HTML комментарии помещаются между тегами <! и —>.
Восклицательный знак после угловой скобки (<!) сообщает браузеру, что дальнейший текст не является HTML-кодом. Тег, в который помещается комментарий, нестандартный: угловая скобка в открывающем и закрывающем теге только одна.
Комментарии в HTML
Как всегда напоминаю, что есть замечательный видеокурс о вёрстке сайтов, в котором рассказывается в том числе о HTML и CSS:
В любом программном коде часто возникает необходимость вставки комментариев. И хотя HTML — это не язык программирования, на нём всё равно пишется код. А это значит, что и в HTML иногда требуется оставлять комментарии, которые будут видны веб-мастеру при просмотре кода страницы, но не будут видны пользователю при просмотре страницы в браузере.
В этой статье и видео я расскажу о том, как вставлять комментарии в HTML-код.
Итак, комментарии в HTML помещаются между особыми элементами разметки — между <!— и —> . Например:
В некоторых источниках пишут, что после символов <!— и перед символами —> обязательно должны быть пробелы. Я советую соблюдать это правило, хотя почти все современные браузеры распознают комментарии и без выполнения этого условия.
Браузер Internet Explorer поддерживает ещё один вид комментариев. Текст, заключённый между тегами <comment> и </comment> в Internet Explorer также является комментарием и не отображается браузером. Однако остальные браузеры не поддерживают этот тег, поэтому использовать его я не советую.
Ну вот, в общем-то, и всё. Вопрос простой, но изучить его необходимо. Потому как при вёрстке сложных страниц без комментариев никак не обойтись.
Для лучшего понимания посмотрите видео (выше) и изучите курс о вёрстке сайтов.