Method XmlNode():createComment() Foundation

Creates a comment node.

Syntax
CLASS METHOD :createComment( <cContent> ) --> oXmlNode
Parameters
<cContent>
A character string with the comment.
Return

An XmlNode() object representing the new comment node.

Description

The method :createComment() creates a comment node, which specifies a section in the XML document which is to be ignored by the XML parser. This can be used to add annotations about the document's structure, for example.

The comment node returned by :createComment() is not associated with any other node. Instead, it must be added to an existing node or document node using the :addChild() method.

Feedback

If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.