This documentation is archived and is not being maintained.

XComment Constructor (String)

Initializes a new instance of the XComment class with the specified string content.

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

public XComment(
	string value
)

Parameters

value
Type: System.String

A string that contains the contents of the new XComment object.

ExceptionCondition
ArgumentNullException

The value parameter is null.

The following example creates an element that contains a comment as a child node.

XElement root = new XElement("Root",
    new XComment("This is a comment")
);
Console.WriteLine(root);

This example produces the following output:

<Root>
  <!--This is a comment-->
</Root>

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, 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

.NET Compact Framework

Supported in: 3.5

XNA Framework

Supported in: 3.0
Show: