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>

.NET Framework

Supported in: 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: