XmlDocument::CreateComment Method
Creates an XmlComment containing the specified data.
Assembly: System.Xml (in System.Xml.dll)
Parameters
- data
- Type: System::String
The content of the new XmlComment.
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.
The following example creates a comment and adds it to an XML document.
#using <System.Xml.dll> using namespace System; using namespace System::IO; using namespace System::Xml; int main() { XmlDocument^ doc = gcnew XmlDocument; doc->LoadXml( "<book genre='novel' ISBN='1-861001-57-5'><title>Pride And Prejudice</title></book>" ); //Create a comment. XmlComment^ newComment; newComment = doc->CreateComment( "Sample XML document" ); //Add the new node to the document. XmlElement^ root = doc->DocumentElement; doc->InsertBefore( newComment, root ); Console::WriteLine( "Display the modified XML..." ); doc->Save( Console::Out ); }
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.