JavaScript метод document.createComment()

Определение и применение

JavaScript метод .createComment() объекта document позволяет создать новый узел комментария и возвратить его.

Поддержка браузерами

Спецификация: dom.spec.whatwg

Поддерживается во всех основных браузерах с 2015 года.

Показать браузеры
Совместимостьapi.Document.createComment
ВозможностьКомпьютерыМобильные
ChromeEdgeFirefoxOperaSafariChrome AndroidFirefox for AndroidOpera AndroidSafari on iOSSamsung BrowserWebView AndroidWebView on iOS
createComment✓1✓12✓1✓≤12.1✓1✓18✓4✓≤12.1✓1✓1.0✓4.4✓1

поддерживаетсяс ограниченияминет поддержкинет данных≤31 — не позднее версии 31

JavaScript синтаксис

JavaScript
const comment = document.createComment(data);

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

DOM Standard.

Значения параметров

Параметры document.createComment()
Параметр Описание
data Строковое значение, содержащее данные, которые будут добавлены в узел комментария. Обязательный параметр.

Пример использования

Создание и добавление комментария

Нажмите ▶, затем кнопку в результате: комментарий не отображается на странице, но в консоли появятся имя добавленного узла #comment и его текст.

index.html
HTML
<button data-example-event-0="">Нажми меня</button>
<!-- добавляем атрибут событий onclick -->
main.js
JavaScript
function myFunc() {
    const comment = document.createComment("Hello! I'm a hidden secret comment.") // создаем узел комментария
    document.body.appendChild(comment) // добавляем узел комментария в качестве последнего дочернего узла элемента <body>
    console.log(document.body.lastChild.nodeName, document.body.lastChild.data) // комментарий не виден на странице
}

document.querySelector('[data-example-event-0]').addEventListener('click', function (event) {
    myFunc()
})
style.css
CSS
body {
  margin: 16px;
  font:
    16px/1.5 system-ui,
    sans-serif;
  overflow-wrap: anywhere;
}
img,
input,
select,
textarea,
button {
  max-width: 100%;
}

В этом примере с использованием метода addEventListener() при нажатии на кнопку (HTML элемент <button>) вызываем функцию myFunc(), которая с использованием JavaScript метода .createComment() объекта document создает и возвращает новый узел комментария. Далее с помощью метода appendChild() объекта Node добавляем узел комментария в качестве последнего дочернего узла элемента <body>.