Document: createComment() method

{{APIRef("DOM")}}

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 {{domxref("Comment")}} object.

Examples

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

{{Specifications}}

Browser compatibility

{{Compat}}