Комментарии в HTML, как и в других языках программирования или разметки, позволяют предоставлять другим разработчикам информацию о специфике разработки, не затрагивая пользовательский интерфейс. Однако, в отличие от других языков, HTML-комментарии могут использоваться для указания HTML-элементов (только для Internet Explorer). В этом разделе объясняется, как писать комментарии HTML.
HTML-комментарии могут использоваться для пояснительных заметок . Они должны начинаться с <!--
и заканчиваться -->
, следующим образом:
<!-- Это HTML-комментарий! -->
Они могут быть внутри другого элемента:
<h1> Эта часть будет отображаться <!-- а эта нет -->.</h1>
Комментарии могут занимать несколько строк:
<!-- Это многострочный комментарий HTML.
Все, что здесь, не будет отображаться браузером.
Вы можете «закомментировать» целые разделы HTML-кода.
-->
Но комментарии не могут быть в другом теге HTML, например:
<h1 <!-- testAttribute="something" -->> Это не сработает </ h1>
Это приводит к недопустимому коду HTML, поскольку весь блок <h1 <!-- testAttribute="something" -->
будет считаться одним начальным тегом h1
с некоторой не верной информацией, за которой следует единственная закрывающаяся скобка >
, которая ничего не делает.
Для совместимости с инструментами, которые парсят HTML как XML или SGML, содержимое вашего комментария не должно содержать два тире подряд --
.
Строчные элементы такие как span
или a
часто содержат символы пробела до и после их в документе. Чтобы избежать очень длинных строк в разметке (которые трудно читать) и непреднамеренных пробельных символов (что влияет на форматирование), пробельные символы могут быть закомментированы.
<!-- Используйте HTML-комментарий для устранения символа новой строки ниже: -->
<a href="#">Надеюсь, после этого не будет лишних пробелов!</a><!--
--><button>Кнопка</button>
Попробуйте этот код без комментария между строчными элементами, и между ними будет один пробел. Например:
<!-- Используйте HTML-комментарий для устранения символа новой строки ниже: -->
<p><a href="#">Надеюсь, после этого не будет лишних пробелов!</a><!--
--><button>Кнопка</button></p>
<!-- Без комментария вы можете увидеть разницу в форматировании -->
<p><a href="#">Надеюсь, после этого не будет лишних пробелов!</a>
<button>Кнопка</button></p>
Получим: