Для чего нужны комментарии в html

Большая Энциклопедия HTML #4. Комментарии в HTML

Что такое комментарий, и для чего нужны комментарии в HTML? Если говорить о программировании, то это определенная информация, которая написана в коде программы для его пояснения. Эта информация никак не влияет на выполнение кода программы и конечно же не отображается в программе для пользователя.

Комментарии также применяются и в языке разметки HTML для пояснения определенных участков кода. Благодаря комментариям в HTML, текст кода лучше воспринимается другими веб-разработчиками (да и вами тоже). Это позволяет очень быстро понять для чего был написан (или найти, где находится) тот, или иной участок кода.

Использование комментариев в HTML значительно упрощает процесс редактирования HTML-документа. Ведь уже через несколько месяцев, вы забудете, где и как описывали определенный блок сайта. Но вы легко его найдете, благодаря комментариям.

Еще, при разработке сайта, иногда нужно временно скрыть какой-то контент на сайте. Но при этом его не нужно удалять, потому что этот код нам ещё понадобится. В таком случае можно закомментировать ненужный нам участок кода. А когда он нам опять понадобится, то мы легко сможем его раскомментировать.

Комментарии в HTML не отображаются на страницах сайта. То есть пользователь, просматривая контент сайта, не видит оставленные вами комментарии в HTML разметке. Но он может их увидеть, посмотрев исходный код страницы.

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

Комментарии в HTML добавляются с помощью тега

Пример:

Примечания

Комментарии могут использоваться в любом месте страницы, кроме тегов и . Внутри тега комментарии не работают. Если вы попытаетесь, прописать комментарий внутри , то он будет выведен в заголовке веб-страницы. А внутри тега у нас каскадные таблицы стилей и для их комментирования используется другой способ. О комментариях в CSS мы поговорим в соответствующей теме немного позже.

Вложенные комментарии в HTML не допускаются. Это когда один комментарий находится внутри другого.

Если вы используете в качестве HTML редактора Visual Studio Code и вам нужно быстро закомментировать (или раскомментировать) строку, то можно использовать горячие клавиши Ctrl + /.

В Notepad++, чтобы быстро закомментировать строку можно использовать сочетание клавиш Ctrl+K, а чтобы раскомментировать строку — Ctrl+Q.

HTML-документ с примером написания комментариев, находится в папке exemple002. Этот файл вы можете открыть обычным блокнотом и посмотреть как правильно оформляется комментарий в HTML.

Для чего нужны комментарии в html

Тег добавляет комментарий в код документа. Текст комментария не отображается на странице. Разрешается внутрь комментария добавлять другие теги, вложенные комментарии (когда один комментарий расположен внутри другого) недопустимы.

Синтаксис

Атрибуты

Пример 1. Использование комментариев

HTML 4.01 IE Cr Op Sa Fx

      
Меню
 
Содержимое документа
  

Пример 2. Использование комментариев

HTML5 IE Cr Op Sa Fx

Примечание

Двойной дефис внутри комментария (—) воспринимается как часть комментария и соответственно его наличие приводит к ошибке при валидации документа.

Статьи по теме

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

Иногда нужно оставить скрытую заметку или пояснить что-то в коде человеческим языком. Такое примечание пригодится и себе в будущем, и следующим разработчикам, которые будут работать над вашим проектом. Именно для этого изначально были придуманы комментарии! Вся их прелесть в том, что пользователи их никогда не увидят. Это секретная почта для разработчиков ��

Для комментариев находится и более утилитарное применение: скрывать блоки кода со страницы, не удаляя их из файла.

Пример

Скопировать ссылку «Пример» Скопировано

  Привет! Я комментарий в HTML-коде, меня не видно на странице--> 
Я — обычный текст. Меня видно на странице!  p>Я — обычный текст. Меня видно на странице!p>    Скопировать Скопировано Не удалось скопировать   

Как пишется

Скопировать ссылку «Как пишется» Скопировано

В HTML возможен только один тип комментариев, в отличие от комментариев в CSS и JS.

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

При помощи ровно тех же конструкций мы можем временно спрятать блок кода.

Подсказки

Скопировать ссылку «Подсказки» Скопировано

�� Содержимое комментария может быть любым, но спецификация перечисляет конкретные ситуации, в которых браузеру будет сложно понять: это содержимое комментария, или он закрывается?

�� Нельзя вкладывать один комментарий в другой. Да и зачем?

�� Комментарии не работают внутри тега , но там вообще никакие теги не работают, так что неудивительно.

�� Чтобы быстро закомментировать или раскомментировать текущую строку или выделенный блок кода, в большинстве редакторов можно нажать Ctrl / или Cmd / .

На практике

Скопировать ссылку «На практике» Скопировано

Алёна Батицкая советует

Скопировать ссылку «Алёна Батицкая советует» Скопировано

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

Комментарий — твой хороший друг ��

�� Иногда для подключения чего-нибудь на страницу требуется скопировать-вставить блок кода, написанного не тобой. Чаще всего блок кода сопровождается комментариями. Всегда копируй весь код вместе с этими комментариями и вставляй его к себе в неизменном коде. Тебе же будет проще потом понять, что эта за странная конструкция и зачем она тут нужна.

Например, для подключения Яндекс.Метрики к сайту нужен такой код:

    (function(m,e,t,r,i,k,a); m[i].l=1*new Date();k=e.createElement(t),a=e.getElementsByTagName(t)[0],k.async=1,k.src=r,a.parentNode.insertBefore(k,a)>) (window, document, "script", "https://mc.yandex.ru/metrika/tag.js", "ym"); ym(id, "init",  clickmap:true, trackLinks:true, accurateTrackBounce:true >);   script> (function(m,e,t,r,i,k,a)m[i]=m[i]||function()(m[i].a=m[i].a||[]).push(arguments)>; m[i].l=1*new Date();k=e.createElement(t),a=e.getElementsByTagName(t)[0],k.async=1,k.src=r,a.parentNode.insertBefore(k,a)>) (window, document, "script", "https://mc.yandex.ru/metrika/tag.js", "ym"); ym(id, "init",  clickmap:true, trackLinks:true, accurateTrackBounce:true >); script> noscript>div>img src="https://mc.yandex.ru/watch/id" style="position:absolute; left:-9999px;" alt="">div>noscript>     Скопировать Скопировано Не удалось скопировать   

Видишь, он начинается с комментария и комментарием заканчивается? Это удобно, визуально отделяет код метрики от остального кода. В дальнейшем тебе проще будет его найти.

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

�� Комментарии видны в браузере в инструментах разработчика, поэтому в них надо писать только документацию, которая поможет работе с кодом. Планы, впечатления и мнения стоит оставить в недоступном для конечных пользователей месте.

Комментарии в HTML.

1) Сделать пометки в коде, по которым можно позже вспомнить, зачем нужен тот или иной фрагмент кода.

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

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

И.т.д. ситуаций может быть масса.

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

2) Вам может также понадобиться оставить информацию в коде о том, кто является создателем этой страницы, когда она создана и.т.д.

Все эти задачи можно решить с помощью комментариев HTML.

Комментарий – это конструкция в коде, которая будет видна, если просматривать исходный html-код, но будет не видна при просмотре страницы в браузере.

Синтаксис у комментариев в html следующий:

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

Рассмотрим HTML-документ со следующим содержимым:

       
Пример текста в абзаце
  

Если вы будете просматривать такой HTML-файл в браузере, то все, что вы увидите, будет текст, который находится внутри абзаца.

Текст комментария на странице никак не отображается, но при просмотре исходного кода документа, комментарии видны и с ними можно работать.

Дмитрий Ченгаев ��
Занимаюсь заказной веб-разработкой. Подписывайтесь на телеграм канал https://t.me/dchengaev 😉
2022-03-24

Чтобы оставить сообщение, зарегистрируйтесь/войдите на сайт через: