Merge branch 'master' of https://github.com/PANDATEEN/YamlDotNet into…

… PANDATEEN-master

YamlDotNet.Test/Serialization/YamlCommentTests.cs

@@ -0,0 +1,39 @@
+using Xunit;
+using Xunit.Abstractions;
+using YamlDotNet.Serialization;
+
+namespace YamlDotNet.Test.Serialization
+{
+    public class YamlCommentTests
+    {
+        protected readonly ITestOutputHelper Output;
+        public YamlCommentTests(ITestOutputHelper helper)
+        {
+            Output = helper;
+        }
+
+        [Fact]
+        public void SerializationWithComment()
+        {
+            var person = new Person();
+            person.Name = "PandaTea";
+            person.Age = 100;
+            person.Sex = "male";
+
+            Serializer serializer = new Serializer();
+            string result = serializer.Serialize(person);
+
+            Output.WriteLine(result);
+        }
+
+        class Person
+        {
+            [YamlMember(Description = "this is a yaml comment about name property")]
+            public string Name { get; set; }
+            [YamlMember(Description = "this is age")]
+            public int Age { get; set; }
+            [YamlMember(Description = "male or female")]
+            public string Sex { get; set; }
+        }
+    }
+}

YamlDotNet/Serialization/ObjectGraphVisitors/DefaultValuesObjectGraphVisitor.cs

@@ -67,7 +67,15 @@ public override bool EnterMapping(IPropertyDescriptor key, IObjectDescriptor val
                     break;
             }
 
+            if (yamlMember != null)
+            {
+                if (yamlMember.Description != null)
+                {
+                    context.Emit(new Core.Events.Comment(yamlMember.Description, false));
+                }
+            }
+
             return base.EnterMapping(key, value, context);
         }
     }
-}
+}

YamlDotNet/Serialization/YamlMemberAttribute.cs

@@ -30,6 +30,11 @@ namespace YamlDotNet.Serialization
     [AttributeUsage(AttributeTargets.Property | AttributeTargets.Field, AllowMultiple = false)]
     public sealed class YamlMemberAttribute : Attribute
     {
+        /// <summary>
+        /// Decription/Comment about this property
+        /// </summary>
+        public string? Description { get; set; }
+
         /// <summary>
         /// Specifies that this property should be serialized as the given type, rather than using the actual runtime value's type.
         /// </summary>