Document.createComment()

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

Syntax

createComment(data)

Parameters

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

Return value

A new Comment object.

Examples

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

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

console.log(new XMLSerializer().serializeToString(docu));
// 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