XmlDocument.CreateComment(String) Метод

Определение

Пространство имен:

System.Xml

Сборка:

System.Xml.ReaderWriter.dll

Исходный код:

XmlDocument.cs

Создает объект XmlComment, содержащий указанные данные.

public:
 virtual System::Xml::XmlComment ^ CreateComment(System::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

Параметры

data

String

Содержимое нового класса XmlComment.

Возвращаемое значение

XmlComment

Новый объект XmlComment.

Примеры

В следующем примере создается комментарий и добавляется в XML-документ.

#using <System.Xml.dll>

using namespace System;
using namespace System::IO;
using namespace System::Xml;
int main()
{
   XmlDocument^ doc = gcnew 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 );
}

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

Комментарии

Хотя этот метод создает новый объект в контексте документа, он не добавляет его автоматически в дерево документа. Чтобы добавить новый объект, необходимо явно вызвать один из методов insert узла.

В соответствии с рекомендацией W3C Xml 1.0 узлы комментариев разрешены только в узлах Document, Element и EntityReference, если узел EntityReference не является дочерним по отношению к узлу Атрибута.