Mono Class Library: System.Xml.XmlTextWriter Overview | Members

System.Xml.XmlTextWriter.WriteComment Method

Writes out a comment containing the specified text.

public override void WriteComment (string text)

Parameters

text
A string containing the 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

This method writes <!--text-->.

If text is null or string.Empty , this method writes a comment with no content, <!---->.

Note:

This method overrides XmlWriter.WriteComment(string).

Requirements

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