W3cubDocs

/Web APIs

Document: createComment() method

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 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

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
createComment 1 12 1 6 ≤12.1 1 4.4 18 4 ≤12.1 1 1.0

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/Document/createComment