Overview - aaubry/YamlDotNet GitHub Wiki

Overview

YamlDotNet is organized into three main namespaces:

  • YamlDotNet.Core
    Provides the basic building blocks to parse and emit YAML streams. The Parser and the Scanner work together to tranform a YAML text file into a sequence of events. The Emitter performs the opposite, producing a YAML text file from a sequence of events.

  • YamlDotNet.Serialization
    Contains the Deserializer and Serializer that can map an object graph from/to a YAML document, respectively. Most of the users of the library will want to use these.

  • YamlDotNet.RepresentationModel
    Offers an alternative model to manipulate YAML documents, that exposes the entire semantics of the YAML Representation Graph.

Overview

Design Principles

This project attempts to follow the SOLID principles. The aim is to have highly maintainable code that can be easily extended, and that is composed of small parts that can be recombined to address use cases.