Использование комментариев HTML <!-- … -->

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

Комментарии начинаются со строки <!-- и заканчиваются строкой -->; обычно между ними находится текст. Этот текст не может начинаться со строки > или ->, содержать строки --> или --!> либо заканчиваться строкой <!-, хотя <! допускается.

Браузер игнорирует комментарии при обработке кода. Иными словами, они не отображаются на странице — только в коде. Комментарии HTML позволяют добавлять полезные заметки о коде или его логике.

Всё вышесказанное относится и к комментариям XML. Кроме того, в XML, например в разметке SVG или MathML, комментарий не может содержать последовательность символов --.

Комментарии могут занимать одну или несколько строк. Их можно использовать в следующих местах:

• До и после объявления типа документа
• До и после элемента <html>
• В качестве содержимого большинства элементов, за исключением: <script>, <style>, <title>, <textarea>, поскольку эти элементы интерпретируют своё содержимое как обычный текст

Синтаксис

<!-- Comment -->

Примеры

<!-- A one-line comment -->

<!--
A comment
that stretches
over several
lines
-->

<!-- The comment below disables
   the HTML contained within -->
<!--
<p>
   This content will not be rendered.
</p>
-->

Примечания

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

Как и в большинстве языков программирования, использующих синтаксис комментариев <!-- -->, комментарии нельзя вкладывать друг в друга. Иными словами, первое вхождение --> после <!-- завершает комментарий.

Хотя комментарии начинаются с < и заканчиваются >, комментарий не является элементом HTML.

Спецификации

См. также

• Комментарии в JavaScript
• Комментарии в CSS
• Comment API (Comment наследуется от Node)