Partager via


XmlDocument.CreateComment(String) Méthode

Définition

Crée un élément XmlComment contenant les données spécifiées.

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

Paramètres

data
String

Contenu du nouvel élément XmlComment.

Retours

XmlComment

Nouvelle XmlComment.

Exemples

L’exemple suivant crée un commentaire et l’ajoute à un document 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

Remarques

Bien que cette méthode crée le nouvel objet dans le contexte du document, il n’ajoute pas automatiquement le nouvel objet à l’arborescence de documents. Pour ajouter le nouvel objet, vous devez appeler explicitement l’une des méthodes d’insertion de nœud.

Selon la recommandation W3C Extensible Markup Language (XML) 1.0, les nœuds de commentaire sont autorisés uniquement dans les nœuds Document, Element et EntityReference, lorsque le nœud EntityReference n’est pas un enfant d’un nœud Attribut.

S’applique à