Перейти к содержимому

HTML-комментарии

HTML-комментарии используются для обозначения разделов документа или вставки заметок, объясняющих код. Они помогают понять код и повысить его читаемость. Синтаксис комментариев также можно использовать для временного исключения блоков кода вместо их удаления.

Для определения HTML-комментариев мы используем синтаксис <!-- ... -->. Браузеры игнорируют этот синтаксис и не показывают его содержимое пользователю.

Все браузеры поддерживают HTML-комментарии и игнорируют их содержимое.

TIP

HTML-комментарии можно использовать в любом месте документа, кроме тега <title>. Они также не работают внутри тега <style>, так как CSS использует другой синтаксис для комментариев.

Корректные и некорректные комментарии

Комментарий не может быть вложен в другой комментарий. Последовательность из двух дефисов («--») не может встречаться внутри комментария, если она не является частью закрывающей последовательности (-->). Также важно убедиться, что в начале строки комментария нет пробелов.

Многострочные комментарии

HTML поддерживает как однострочные, так и многострочные комментарии. Мы можем использовать многострочные комментарии с начальным синтаксисом <!-- и конечным синтаксисом -->.

Синтаксис

Комментарии записываются между символами <!-- и -->.

Пример HTML-комментария:

HTML-комментарии

html
<!DOCTYPE html>
<html>
  <head>
    <title>The title of the document.</title>
  </head>
  <body>
    <h1>The main heading</h1>
    <!--  <p>We want to hide this part of the code temporarily. </p> -->
    <a href="https://www.w3docs.com">Homepage</a>  
    <!--  <p>This is a link to the homepage</p> -->
  </body>
</html>

Результат

html-comments

Практика

Какой правильный способ добавить комментарий в HTML?

Считаете ли это полезным?

Предпросмотр dual-run — сравните с маршрутами Symfony на продакшене.