System.Xml.XmlTextWriter.WriteComment Method

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

Syntax

public override void WriteComment (string text)

Parameters

text
Text to place inside the comment.

Exceptions

TypeReason
ArgumentExceptionThe text would result in a non-well formed XML document
InvalidOperationExceptionThe XmlTextWriter.WriteState is WriteState.Closed.

Remarks

Note:

In the dnprdnext release, the recommended practice is to create System.Xml.XmlWriter instances using the erload:System.Xml.XmlWriter.Create method and the System.Xml.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 <!---->.

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