将包含多子元素的复杂XML元素转换为注释并保留格式

你遇到的问题其实是因为默认的DOM操作（比如InnerXml/OuterXml）会忽略原始的空白和换行——DOM本身并不存储这些格式信息，除非你特意配置。下面给你几个简便的解决方案，不用自己手动处理缩进和换行：

方案1：利用XmlWriter生成带格式的XML字符串 #

如果你的代码里已经持有XmlElement对象，可以借助XmlWriter来生成符合格式要求的XML内容，再包装成注释：

// 假设你已经获取到要注释的element节点
XmlElement elementToComment = ...;

// 配置XmlWriter的格式规则，匹配你的原始XML风格
XmlWriterSettings settings = new XmlWriterSettings
{
    Indent = true,
    IndentChars = "  ", // 用两个空格缩进，可根据你的习惯调整
    OmitXmlDeclaration = true
};

// 生成带格式的XML字符串
using (StringWriter sw = new StringWriter())
using (XmlWriter writer = XmlWriter.Create(sw, settings))
{
    elementToComment.WriteTo(writer);
}
string formattedElement = sw.ToString();

// 包装成注释并替换原节点
XmlComment comment = doc.CreateComment(formattedElement);
elementToComment.ParentNode.ReplaceChild(comment, elementToComment);

这个方法会自动帮你处理缩进和换行，输出的格式可以完全匹配你的需求。

方案2：加载XML时保留空白节点 #

如果你是从文件/字符串加载XML，先设置XmlDocument.PreserveWhitespace = true，这样DOM会保留原始的空白和换行节点，之后获取element.OuterXml就能拿到带格式的内容：

XmlDocument doc = new XmlDocument();
doc.PreserveWhitespace = true; // 关键设置，必须在加载前配置
doc.Load("yourXmlFile.xml"); // 或者用LoadXml(string)加载字符串

XmlElement elementToComment = doc.SelectSingleNode("//Element") as XmlElement;
string formattedElement = elementToComment.OuterXml;
XmlComment comment = doc.CreateComment(formattedElement);
elementToComment.ParentNode.ReplaceChild(comment, elementToComment);

注意：这个方法只对原始XML中已存在的空白和换行有效，如果原始XML本身就是压缩的，它不会自动帮你格式化。

方案3：用XmlReader读取原始XML片段（适合大文件） #

如果你的XML文件体积很大，不想加载整个DOM，可以用XmlReader定位到目标节点，直接读取它的原始XML内容：

using (XmlReader reader = XmlReader.Create("yourXmlFile.xml"))
{
    // 定位到目标<Element>节点
    while (reader.Read())
    {
        if (reader.NodeType == XmlNodeType.Element && reader.Name == "Element")
        {
            // 读取当前节点的原始XML片段，完全保留格式
            string formattedElement = reader.ReadOuterXml();
            // 后续可将此字符串作为注释写入目标XML
            break;
        }
    }
}

这个方法性能更好，而且能100%保留原始XML的换行、缩进格式，适合处理大文件场景。

内容的提问来源于stack exchange，提问作者Gordon