Document: createComment() method

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

createComment() creates a new comment node, and returns it.

Syntax

js
createComment(data)

Parameters

data

A string containing the data to be added to the Comment.

Return value

A new Comment object.

Examples

js
const doc = new DOMParser().parseFromString("<xml></xml>", "application/xml");
const comment = doc.createComment(
  "This is a not-so-secret comment in your document",
);

doc.querySelector("xml").appendChild(comment);

console.log(new XMLSerializer().serializeToString(doc));
// Displays: <xml><!--This is a not-so-secret comment in your document--></xml>

Specifications

Specification
DOM Standard
# ref-for-dom-document-createcomment①

Browser compatibility

BCD tables only load in the browser