System.Xml.XmlDocument.CreateComment Method

Creates an System.Xml.XmlComment containing the specified data.

Syntax

public virtual XmlComment CreateComment (string data)

Parameters

data
The content of the new XmlComment.

Returns

The new XmlComment.

Remarks

Although this method creates the new object in the context of the document, it does not automatically add the new object to the document tree. To add the new object, you must explicitly call one of the node insert methods.

According to the W3C Extensible Markup Language (XML) 1.0 recommendation (www.w3.org/TR/1998/REC-xml-19980210), Comment nodes are only allowed within Document, Element and EntityReference nodes, when the EntityReference node is not a child of an Attribute node.

Requirements

Namespace: System.Xml
Assembly: System.Xml (in System.Xml.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0, 4.0.0.0