INI File Parser 技术文档

以下为INI File Parser项目的详细技术文档，包括安装指南、使用说明以及API使用文档。

1. 安装指南

INI File Parser库可通过以下方式安装：

• 使用NuGet命令行工具：

  > nuget install ini-parser
  

• 在Visual Studio的包管理器控制台中安装：

  PM> Install-Package ini-parser
  

• 如果使用Visual Studio，可以下载NuGet包管理器扩展来为项目添加NuGet依赖。

• 如果使用MonoDevelop / Xamarin Studio，可以安装MonoDevelop NuGet AddIn以从IDE中添加库依赖。

2. 项目的使用说明

在所有代码示例中，都需要添加以下命名空间：

using IniParser;
using IniParser.Model;

INI数据存储在嵌套的字典中，因此访问一个节内的键对应的值非常直接。使用提供的方法之一加载数据。

var parser = new FileIniDataParser();
IniData data = parser.ReadFile("Configuration.ini");

从命名的节中检索键的值。值总是作为string类型检索。

string useFullScreenStr = data["UI"]["fullscreen"];
// useFullScreenStr 包含 "true"
bool useFullScreen = bool.Parse(useFullScreenStr);

在字典中修改值（而不是检索到的值），然后保存到新文件或覆盖。

data["UI"]["fullscreen"] = "true";
parser.WriteFile("Configuration.ini", data);

更多使用示例，请参考项目的wiki。

3. 项目API使用文档

合并INI文件

合并INI文件是一个单一方法操作：

var parser = new IniParser.Parser.IniDataParser();

IniData config = parser.Parse(File.ReadAllText("global_config.ini"));
IniData user_config = parser.Parse(File.ReadAllText("user_config.ini"));
config.Merge(user_config);

现在config包含了两个INI文件的数据，并且键和节的值被用户配置文件中的值覆盖。

也可以只合并单个节：

config["user_settings"].Merge(user_config["user_settings"]);

注释

库允许修改INI文件中的注释。但是请注意，将文件写回磁盘时，注释会被重新排列，以便注释位于它们所指元素的之前。

要查询、添加或删除注释，可以访问SectionData和KeyData模型中可用的Comments属性。

var listOfCommentsForSection = config["user_settings"].Comments;
var listOfCommentsForKey = config["user_settings"].GetKeyData("resolution").Comments;

Unity3D

你可以在Unity3D项目中轻松使用此库。只需将代码或DLL放入项目Assets文件夹中即可。

INI-parser实际上被用于ProjectPrefs，这是一个可在Unity资产商店中免费获取的插件，允许你为项目设置自定义首选项。我与该项目无关：感谢Garrafote创建了这个插件。

4. 项目安装方式

请参考上述安装指南部分获取项目安装方式。