如何让C#生成的INI文件格式更易读？

我用C#调用Win32的GetPrivateProfileString和WritePrivateProfileString生成INI文件，结果如下：

[SectionA]
valueA=0
valueB=1
valueC=2
[SectionB]
valueD=0
valueE=1
valueF=2

希望节之间能空一行提升可读性，但直接给某个键值加\n的方法在键值顺序变化时会出错，比如：

[SectionA]
valueC=2

valueA=0
valueB=1
[SectionB]
valueD=0
valueE=1
valueF=2

方案1：生成后重新格式化INI文件 #

Win32的INI API本身不支持控制节之间的空行，而且它写入键值的顺序不一定和你调用的顺序一致，所以靠给特定键加换行的方法不可靠。最稳妥的方式是写完所有内容后，读取文件并重新处理格式：

// 读取现有INI文件
var lines = File.ReadAllLines("your_config.ini");
var formattedLines = new List<string>();
bool isFirstSection = true;

foreach (var line in lines)
{
    // 判断当前行是否是节头部（以[开头并以]结尾）
    if (!string.IsNullOrWhiteSpace(line) && line.StartsWith("[") && line.EndsWith("]"))
    {
        if (!isFirstSection)
        {
            // 非第一个节，先加空行
            formattedLines.Add("");
        }
        isFirstSection = false;
    }
    formattedLines.Add(line);
}

// 写入格式化后的内容
File.WriteAllLines("your_config.ini", formattedLines);

这个逻辑会遍历每一行，遇到新的节时（除了第一个），在前面插入空行，不管键值的顺序如何，都能保证节之间有且只有一个空行。

方案2：自定义INI读写逻辑（替代Win32 API） #

如果不想依赖Win32 API，可以自己实现INI的管理和写入，完全控制输出格式：

public class CustomIniWriter
{
    // 存储节和对应的键值对
    private readonly Dictionary<string, Dictionary<string, string>> _sections = new();

    /// <summary>
    /// 添加或更新INI中的键值
    /// </summary>
    public void SetValue(string section, string key, string value)
    {
        if (!_sections.ContainsKey(section))
        {
            _sections[section] = new Dictionary<string, string>();
        }
        _sections[section][key] = value;
    }

    /// <summary>
    /// 将内容写入INI文件
    /// </summary>
    public void SaveToFile(string filePath)
    {
        var outputLines = new List<string>();
        bool isFirstSection = true;

        foreach (var section in _sections)
        {
            if (!isFirstSection)
            {
                // 节之间加空行
                outputLines.Add("");
            }
            // 写入节头部
            outputLines.Add($"[{section.Key}]");
            // 写入当前节的所有键值
            foreach (var kvp in section.Value)
            {
                outputLines.Add($"{kvp.Key}={kvp.Value}");
            }
            isFirstSection = false;
        }

        File.WriteAllLines(filePath, outputLines);
    }
}

使用示例：

var iniWriter = new CustomIniWriter();
// 添加SectionA的键值
iniWriter.SetValue("SectionA", "valueA", "0");
iniWriter.SetValue("SectionA", "valueB", "1");
iniWriter.SetValue("SectionA", "valueC", "2");
// 添加SectionB的键值
iniWriter.SetValue("SectionB", "valueD", "0");
iniWriter.SetValue("SectionB", "valueE", "1");
iniWriter.SetValue("SectionB", "valueF", "2");
// 写入文件
iniWriter.SaveToFile("your_config.ini");

这样生成的INI文件会自动在节之间添加空行，而且键值的顺序完全由你添加的顺序决定（如果需要排序，可以在遍历键值时做排序处理）。

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