XmlWriter.WriteComment Method (String)

 

When overridden in a derived class, writes out a comment <!--...--> containing the specified text.

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

abstract WriteComment : 
        text:string -> unit

Parameters

text
Type: System.String

Text to place inside the comment.

Exception Condition
ArgumentException

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

InvalidOperationException

An XmlWriter method was called before a previous asynchronous operation finished. In this case, InvalidOperationException is thrown with the message “An asynchronous operation is already in progress.”

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

If text contains an invalid sequence of two dashes "--" the XmlWriter can either throw an ArgumentException (XmlTextWriter objects) or insert a space between the dashes "- -" so that the text is a valid XML comment (XmlWriter objects created by the Create method).

For the asynchronous version of this method, see WriteCommentAsync.

The following example writes an XML file representing a book.

No code example is currently available or this language may not be supported.

Universal Windows Platform
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show: