This documentation is archived and is not being maintained.

XmlTextWriter.WriteComment Method

Writes out a comment <!--...--> containing the specified text.

Namespace:  System.Xml
Assembly:  System.Xml (in System.Xml.dll)

public override void WriteComment(
	string text
)

Parameters

text
Type: System.String

Text to place inside the comment.

ExceptionCondition
ArgumentException

The text would result in a non-well formed XML document

InvalidOperationException

The WriteState is Closed.

NoteNote:

In the .NET Framework version 2.0 release, the recommended practice is to create XmlWriter instances using the XmlWriter.Create method and the XmlWriterSettings class. This allows you to take full advantage of all the new features introduced in this release. For more information, see Creating XML Writers.

If text is either null or String.Empty, this method writes a Comment with no data content, for example <!---->.

The following example writes an XML file representing a book.

using System;
using System.IO;
using System.Xml;

public class Sample
{
  private const string filename = "sampledata.xml";

  public static void Main()
  {
     XmlTextWriter writer = null;

     writer = new XmlTextWriter (filename, null);
     //Use indenting for readability.
     writer.Formatting = Formatting.Indented;

     //Write the XML delcaration. 
     writer.WriteStartDocument();

     //Write the ProcessingInstruction node.
     String PItext="type='text/xsl' href='book.xsl'";
     writer.WriteProcessingInstruction("xml-stylesheet", PItext);

     //Write the DocumentType node.
     writer.WriteDocType("book", null , null, "<!ENTITY h 'hardcover'>");

     //Write a Comment node.
     writer.WriteComment("sample XML");

     //Write a root element.
     writer.WriteStartElement("book");

     //Write the genre attribute.
     writer.WriteAttributeString("genre", "novel");

     //Write the ISBN attribute.
     writer.WriteAttributeString("ISBN", "1-8630-014");

     //Write the title.
     writer.WriteElementString("title", "The Handmaid's Tale");

     //Write the style element.
     writer.WriteStartElement("style");
     writer.WriteEntityRef("h");
     writer.WriteEndElement(); 

     //Write the price.
     writer.WriteElementString("price", "19.95");

     //Write CDATA.
     writer.WriteCData("Prices 15% off!!");

     //Write the close tag for the root element.
     writer.WriteEndElement();

     writer.WriteEndDocument();

     //Write the XML to file and close the writer.
     writer.Flush();
     writer.Close();  

     //Load the file into an XmlDocument to ensure well formed XML.
     XmlDocument doc = new XmlDocument();
     //Preserve white space for readability.
     doc.PreserveWhitespace = true;
     //Load the file.
     doc.Load(filename);  

     //Display the XML content to the console.
     Console.Write(doc.InnerXml);  

  }

}
#using <mscorlib.dll>
#using <System.Xml.dll>
using namespace System;
using namespace System::IO;
using namespace System::Xml;

int main()
{
     XmlTextWriter* writer = 0;
     String* filename = S"sampledata.xml";

     writer = new XmlTextWriter (filename, 0);
     //Use indenting for readability.
     writer->Formatting = Formatting::Indented;

     //Write the XML delcaration. 
     writer->WriteStartDocument();

     //Write the ProcessingInstruction node.
     String* PItext=S"type='text/xsl' href='book.xsl'";
     writer->WriteProcessingInstruction(S"xml-stylesheet", PItext);

     //Write the DocumentType node.
     writer->WriteDocType(S"book", 0 , 0, S"<!ENTITY h 'hardcover'>");

     //Write a Comment node.
     writer->WriteComment(S"sample XML");

     //Write a root element.
     writer->WriteStartElement(S"book");

     //Write the genre attribute.
     writer->WriteAttributeString(S"genre", S"novel");

     //Write the ISBN attribute.
     writer->WriteAttributeString(S"ISBN", S"1-8630-014");

     //Write the title.
     writer->WriteElementString(S"title", S"The Handmaid's Tale");

     //Write the style element.
     writer->WriteStartElement(S"style");
     writer->WriteEntityRef(S"h");
     writer->WriteEndElement(); 

     //Write the price.
     writer->WriteElementString(S"price", S"19.95");

     //Write CDATA.
     writer->WriteCData(S"Prices 15% off!!");

     //Write the close tag for the root element.
     writer->WriteEndElement();

     writer->WriteEndDocument();

     //Write the XML to file and close the writer.
     writer->Flush();
     writer->Close();  

     //Load the file into an XmlDocument to ensure well formed XML.
     XmlDocument* doc = new XmlDocument();
     //Preserve white space for readability.
     doc->PreserveWhitespace = true;
     //Load the file.
     doc->Load(filename);  

     //Display the XML content to the console.
     Console::Write(doc->InnerXml);  
}

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0
Show: