XmlWriter.WriteComment(String) Método

Definição

Namespace:

System.Xml

Assembly:

System.Xml.ReaderWriter.dll

Assembly:

System.Xml.dll

Assembly:

netstandard.dll

Quando substituído em uma classe derivada, grava um comentário <!--...--> que contém o texto especificado.

C#

public abstract void WriteComment (string text);

C#

public abstract void WriteComment (string? text);

Parâmetros

text

String

Texto a colocar dentro do comentário.

Exceções

ArgumentException

O texto pode resultar em um documento XML malformado.

InvalidOperationException

Um método XmlWriter foi chamado antes do término de uma operação assíncrona anterior. Nesse caso, InvalidOperationException será gerado com a mensagem “Uma operação assíncrona já está em andamento”.

Exemplos

O exemplo a seguir grava um arquivo XML representando um livro.

C#

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

public class Sample {

  private const string filename = "sampledata.xml";

  public static void Main() {

     XmlWriterSettings settings = new XmlWriterSettings();
     settings.Indent = true;
     XmlWriter writer = XmlWriter.Create(filename, settings);

     // Write the Processing Instruction node.
     String PItext="type=\"text/xsl\" href=\"book.xsl\"";
     writer.WriteProcessingInstruction("xml-stylesheet", PItext);

     // Write the DocumentType node.
     writer.WriteDocType("book", null , null, "<!ENTITY h \"hardcover\">");

     // Write a Comment node.
     writer.WriteComment("sample XML");

     // Write the root element.
     writer.WriteStartElement("book");

     // Write the genre attribute.
     writer.WriteAttributeString("genre", "novel");

     // Write the ISBN attribute.
     writer.WriteAttributeString("ISBN", "1-8630-014");

     // Write the title.
     writer.WriteElementString("title", "The Handmaid's Tale");

     // Write the style element.
     writer.WriteStartElement("style");
     writer.WriteEntityRef("h");
     writer.WriteEndElement();

     // Write the price.
     writer.WriteElementString("price", "19.95");

     // Write CDATA.
     writer.WriteCData("Prices 15% off!!");

     // Write the close tag for the root element.
     writer.WriteEndElement();

     writer.WriteEndDocument();

     // Write the XML to file and close the writer.
     writer.Flush();
     writer.Close();
  }
}

Comentários

Se text for null ou String.Empty, esse método gravará um comentário sem conteúdo de dados, por exemplo <!---->.

Se text contiver uma sequência inválida de dois traços "--" a XmlWriter opção pode lançar um ArgumentException (XmlTextWriter objetos) ou inserir um espaço entre os traços "--" para que o texto seja um comentário XML válido (XmlWriter objetos criados pelo Create método).

Para obter a versão assíncrona deste método, consulte WriteCommentAsync.

Aplica-se a