Как написать комментарий в HTML
Комментарий HTML начинается с <!-- и заканчивается -->. Браузер игнорирует все между этими маркерами, поэтому текст никогда не появляется на странице:
Видны только заголовок и абзац. В HTML один синтаксис комментариев, и он работает и для одной строки, и для нескольких.
Горячая клавиша в VS Code и большинстве редакторов: выделите строки и нажмите Ctrl + / (Cmd + / на Mac). Редактор сам добавит маркеры, а те же клавиши их уберут.
Как закомментировать код
Браузер игнорирует теги внутри комментария, поэтому разметка, обернутая в <!-- и -->, скрывается без удаления. Это самый быстрый способ проверить страницу без какого-то элемента:
Удалите <!-- и --> в строке с баннером, и он появится снова. Закомментированный код все равно скачивается вместе со страницей, поэтому, когда вы уверены, что он не нужен, удалите его.
Комментарии нельзя вкладывать
Первый --> всегда закрывает комментарий. Если закомментированный код уже содержит комментарий, внешний заканчивается раньше времени, и остаток попадает на страницу. Этот пример передает парсеру браузера вложенные комментарии и показывает, что остается видимым:
still meant to be hidden --> отображается как текст. Прежде чем закомментировать большой блок, удалите комментарии внутри него (или измените их -->, чтобы он больше не совпадал).
Еще несколько правил: комментарий не может начинаться с <!--> (это пустой комментарий, и все, что идет дальше, видно), а --!> закрывает комментарий так же, как -->, поэтому не пишите ни то, ни другое в тексте комментария.
Комментарии видны всем
Комментарии входят в HTML, который отправляет сервер, поэтому любой посетитель может прочитать их через просмотр исходного кода или инструменты разработчика. Скрипт тоже может их перечислить:
Пишите в комментариях только заметки о коде. Ничего личного (пароли, ключи API, внутренние адреса, данные клиентов) не должно быть в HTML, ни в комментарии, ни вне его. Инструменты сборки и минификаторы обычно убирают комментарии из рабочего HTML, что заодно экономит несколько байт.
Комментарии в CSS и JavaScript
Комментарии HTML работают только в HTML. Внутри <style> и <script> используется синтаксис комментариев соответствующего языка:
Заголовок становится синим: CSS игнорирует сами маркеры <!-- и --> и все равно применяет правило между ними. Отключить CSS можно только через /* ... */. Этот синтаксис описан на странице комментарии в CSS.
Условные комментарии
В старом коде иногда встречается <!--[if IE]> ... <![endif]-->. Это были инструкции для Internet Explorer 9 и более ранних версий. Все современные браузеры считают их обычными комментариями, поэтому содержимое игнорируется, и весь блок можно удалить.
Частые ошибки
- Вложенные комментарии. Внутренний
-->завершает внешний комментарий. Удалите внутренние комментарии, прежде чем комментировать блок. - Секреты в комментариях. Комментарии получает каждый посетитель.
- Пропущенный
-->. Все после<!--до конца файла исчезает, и кажется, что пропала половина страницы. <!-- -->в CSS. Правила он не отключает. Используйте/* */.//в HTML.// noteотображается как текст. HTML понимает только<!-- -->.
Часто задаваемые вопросы
Как написать комментарий в HTML?
Начните его с <!-- и закончите -->: <!-- This is a comment -->. Браузер игнорирует все между этими маркерами, включая теги, поэтому тем же синтаксисом можно закомментировать код.
Как сделать многострочный комментарий в HTML?
В HTML только один синтаксис комментариев, и он может занимать сколько угодно строк. Поставьте <!-- в первой строке и --> после последней.
Какая горячая клавиша комментирует код в HTML?
В VS Code и большинстве редакторов кода выделите строки и нажмите Ctrl + / (Windows и Linux) или Cmd + / (Mac). Редактор обернет выделение в <!-- и -->, а те же клавиши их уберут.
Можно ли вкладывать комментарии HTML?
Нет. Первый --> завершает комментарий, поэтому в <!-- a <!-- b --> c --> текст c --> появится на странице. Чтобы закомментировать блок, в котором уже есть комментарий, сначала удалите или измените внутренний.
Видят ли пользователи комментарии HTML?
На странице они не отображаются, но приходят в браузер вместе с ней. Любой может прочитать их через просмотр исходного кода или инструменты разработчика, поэтому никогда не пишите в них пароли, ключи и личные заметки.
Работают ли комментарии HTML внутри CSS или JavaScript?
Нет. Внутри элемента <style> используйте /* ... */, а внутри <script> используйте // или /* ... */. Комментарий HTML в блоке стилей не скрывает правила CSS внутри него.