XmlDocument.CreateComment(String) 方法

public:
 virtual System::Xml::XmlComment ^ CreateComment(System::String ^ data);

public virtual System.Xml.XmlComment CreateComment(string data);

public virtual System.Xml.XmlComment CreateComment(string? data);

abstract member CreateComment : string -> System.Xml.XmlComment
override this.CreateComment : string -> System.Xml.XmlComment

Public Overridable Function CreateComment (data As String) As XmlComment

参数

返回

新的 XmlComment。

示例

以下示例创建一个注释并将其添加到 XML 文档。

using System;
using System.IO;
using System.Xml;

public class Sample
{
  public static void Main()
  {
    XmlDocument doc = new XmlDocument();
    doc.LoadXml("<book genre='novel' ISBN='1-861001-57-5'>" +
                "<title>Pride And Prejudice</title>" +
                "</book>");

    //Create a comment.
    XmlComment newComment;
    newComment = doc.CreateComment("Sample XML document");

    //Add the new node to the document.
    XmlElement root = doc.DocumentElement;
    doc.InsertBefore(newComment, root);

    Console.WriteLine("Display the modified XML...");
    doc.Save(Console.Out);
  }
}

Option Explicit
Option Strict

Imports System.IO
Imports System.Xml

Public Class Sample
    
    Public Shared Sub Main()
        Dim doc As New XmlDocument()
        doc.LoadXml("<book genre='novel' ISBN='1-861001-57-5'>" & _
                    "<title>Pride And Prejudice</title>"  & _
                    "</book>")
        
        'Create a comment.
        Dim newComment As XmlComment
        newComment = doc.CreateComment("Sample XML document")
        
        'Add the new node to the document.
        Dim root As XmlElement = doc.DocumentElement
        doc.InsertBefore(newComment, root)
        
        Console.WriteLine("Display the modified XML...")
        doc.Save(Console.Out)
    End Sub
End Class

注解

尽管此方法在文档的上下文中创建新对象，但它不会自动将新对象添加到文档树。 若要添加新对象，必须显式调用节点插入方法之一。

根据 W3C 可扩展标记语言 (XML) 1.0 建议，仅当 EntityReference 节点不是属性节点的子节点时，才允许在 Document、Element 和 EntityReference 节点中使用注释节点。