YamlDotNet 技术文档

1. 安装指南

YamlDotNet 是一个适用于 .NET 运行时的 YAML 库。若要安装 YamlDotNet，您可以通过以下步骤进行：

• 使用 NuGet 包管理器安装：

  在您的项目中选择“管理 NuGet 包”，然后搜索 “YamlDotNet”。选择相应的包并安装。

  或者在命令行中使用以下命令：

  PM> Install-Package YamlDotNet
  

• 如果您不想使用 NuGet，也可以从 这里 下载编译好的二进制文件。

• YamlDotNet 也在 Unity Asset Store 上可用。

2. 项目的使用说明

YamlDotNet 提供了低级别的 YAML 解析和生成，以及一个类似于 XmlDocument 的高级对象模型。此外，它还包括一个序列化库，允许从 YAML 流读取和写入对象。

以下是一些快速入门示例：

序列化对象到字符串

using YamlDotNet.Serialization;
using YamlDotNet.Serialization.NamingConventions;

...

var person = new Person
{
    Name = "Abe Lincoln",
    Age = 25,
    HeightInInches = 6f + 4f / 12f,
    Addresses = new Dictionary<string, Address> {
        { "home", new Address() {
                Street = "2720  Sundown Lane",
                City = "Kentucketsville",
                State = "Calousiyorkida",
                Zip = "99978",
            }},
        { "work", new Address() {
                Street = "1600 Pennsylvania Avenue NW",
                City = "Washington",
                State = "District of Columbia",
                Zip = "20500",
            }},
    }
};

var serializer = new SerializerBuilder()
    .WithNamingConvention(CamelCaseNamingConvention.Instance)
    .Build();
var yaml = serializer.Serialize(person);
System.Console.WriteLine(yaml);

从字符串反序列化到对象

using YamlDotNet.Serialization;
using YamlDotNet.Serialization.NamingConventions;

...

var yml = @"
name: George Washington
age: 89
height_in_inches: 5.75
addresses:
  home:
    street: 400 Mockingbird Lane
    city: Louaryland
    state: Hawidaho
    zip: 99970
";

var deserializer = new DeserializerBuilder()
    .WithNamingConvention(UnderscoredNamingConvention.Instance)
    .Build();

var p = deserializer.Deserialize<Person>(yml);
var h = p.Addresses["home"];
System.Console.WriteLine($"{p.Name} is {p.Age} years old and lives at {h.Street} in {h.City}, {h.State}.");

3. 项目 API 使用文档

YamlDotNet 的 API 文档可以在项目的 Wiki 上找到。这里提供了详细的类和方法说明，以及使用示例。

4. 项目安装方式

项目的安装方式已在“安装指南”部分说明，可以通过 NuGet 包管理器、手动下载二进制文件或通过 Unity Asset Store 进行安装。