document.createComment

Summary

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

Syntax

CommentNode = document.createComment(data) 

Parameters

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

Example

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

docu.getElementsByTagName('xml')[0].appendChild(comment);

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

Notes

  • Will throw a NS_ERROR_DOM_INVALID_CHARACTER_ERR exception if one tries to include the "--" sequence as part of the data, so if based on user data, this potential string would need to be escaped or have its exception caught.

Specification

Document Tags and Contributors

Contributors to this page: Sheppy, ziyunfei, ethertank, Brettz9, kscarfone, Cobra
Last updated by: kscarfone,
Hide Sidebar