feat: 优化注释,优化开发体验. (#541)

joesdu · Sep 23, 2024 · c9a1124 · c9a1124
2 parents 98d6303 + d45d7ba
commit c9a1124
Show file tree

Hide file tree

Showing 4 changed files with 50 additions and 20 deletions.
diff --git a/src/EasilyNET.MongoSerializer.AspNetCore/DateOnlySerializer.cs b/src/EasilyNET.MongoSerializer.AspNetCore/DateOnlySerializer.cs
@@ -11,16 +11,17 @@ namespace EasilyNET.MongoSerializer.AspNetCore;
 ///     <para>
 ///     注意同一类型的序列化方案全局只允许注册一种.也就是说 <see cref="DateOnlySerializerAsString" /> 和 <see cref="DateOnlySerializerAsTicks" /> 会冲突.
 ///     </para>
-/// </remarks>
-/// </summary>
-/// <param name="format"></param>
-/// <example>
+///     <example>
+///     使用方法:
 ///     <code>
 ///  <![CDATA[
 ///  BsonSerializer.RegisterSerializer(new DateOnlySerializerAsString());
 ///   ]]>
 ///  </code>
-/// </example>
+///     </example>
+/// </remarks>
+/// </summary>
+/// <param name="format"></param>
 public sealed class DateOnlySerializerAsString(string format = "yyyy-MM-dd") : StructSerializerBase<DateOnly>
 {
     private readonly StringSerializer InnerSerializer = new();
@@ -39,19 +40,20 @@ public override DateOnly Deserialize(BsonDeserializationContext context, BsonDes
 
 /// <summary>
 /// <see cref="DateOnly" /> 序列化方式,使用Ticks来记录日期
-/// </summary>
 /// <remarks>
 ///     <para>
 ///     注意同一类型的序列化方案全局只允许注册一种.也就是说 <see cref="DateOnlySerializerAsString" /> 和 <see cref="DateOnlySerializerAsTicks" /> 会冲突.
 ///     </para>
-/// </remarks>
-/// <example>
+///     <example>
+///     使用方法:
 ///     <code>
 ///  <![CDATA[
 ///  BsonSerializer.RegisterSerializer(new DateOnlySerializerAsTicks());
 ///   ]]>
 ///  </code>
-/// </example>
+///     </example>
+/// </remarks>
+/// </summary>
 public sealed class DateOnlySerializerAsTicks : StructSerializerBase<DateOnly>
 {
     private readonly Int64Serializer InnerSerializer = new();

diff --git a/src/EasilyNET.MongoSerializer.AspNetCore/JsonNodeSerializer.cs b/src/EasilyNET.MongoSerializer.AspNetCore/JsonNodeSerializer.cs
@@ -12,15 +12,16 @@ namespace EasilyNET.MongoSerializer.AspNetCore;
 ///     <para>
 ///     This serializer handles the serialization and deserialization of <see cref="JsonNode" /> objects.
 ///     </para>
-/// </remarks>
-/// </summary>
-/// <example>
+///     <example>
+///     使用方法:
 ///     <code>
 ///  <![CDATA[
 ///  BsonSerializer.RegisterSerializer(new JsonNodeSerializer());
 ///   ]]>
 ///  </code>
-/// </example>
+///     </example>
+/// </remarks>
+/// </summary>
 public sealed class JsonNodeSerializer : SerializerBase<JsonNode?>
 {
     private readonly StringSerializer InnerSerializer = new();

diff --git a/src/EasilyNET.MongoSerializer.AspNetCore/ServiceCollectionExtensions.cs b/src/EasilyNET.MongoSerializer.AspNetCore/ServiceCollectionExtensions.cs
@@ -15,6 +15,19 @@ public static class ServiceCollectionExtensions
 {
     /// <summary>
     /// 添加自定义序列化规则
+    /// <remarks>
+    ///     <para>
+    ///     为MongoDB添加自定义序列化器,比如MongoDB不支持的类型
+    ///     </para>
+    ///     <example>
+    ///     使用方法:
+    ///     <code>
+    ///  <![CDATA[
+    ///  builder.Services.RegisterSerializer(new TimeOnlySerializerAsString());
+    ///   ]]>
+    ///  </code>
+    ///     </example>
+    /// </remarks>
     /// </summary>
     /// <typeparam name="T">数据类型</typeparam>
     /// <param name="services">IServiceCollection</param>
@@ -28,6 +41,19 @@ public static IServiceCollection RegisterSerializer<T>(this IServiceCollection s
 
     /// <summary>
     /// 注册动态类型 [<see langword="dynamic" /> | <see langword="object" />] 序列化支持
+    /// <remarks>
+    ///     <para>
+    ///     为MongoDB添加动态类型支持,支持匿名类型,方便某些时候进行快速验证一些功能使用,不用声明实体对象.
+    ///     </para>
+    ///     <example>
+    ///     使用方法:
+    ///     <code>
+    ///  <![CDATA[
+    ///  builder.Services.RegisterDynamicSerializer();
+    ///   ]]>
+    ///  </code>
+    ///     </example>
+    /// </remarks>
     /// </summary>
     /// <param name="services"></param>
     /// <returns></returns>

diff --git a/src/EasilyNET.MongoSerializer.AspNetCore/TimeOnlySerializer.cs b/src/EasilyNET.MongoSerializer.AspNetCore/TimeOnlySerializer.cs
@@ -7,20 +7,21 @@ namespace EasilyNET.MongoSerializer.AspNetCore;
 
 /// <summary>
 /// <see cref="TimeOnly" /> 序列化方式,仅存为字符串形式方便人类阅读
-/// </summary>
-/// <param name="format">格式化的格式</param>
 /// <remarks>
 ///     <para>
 ///     注意同一类型的序列化方案全局只允许注册一种.也就是说 <see cref="TimeOnlySerializerAsString" /> 和 <see cref="TimeOnlySerializerAsTicks" /> 会冲突.
 ///     </para>
-/// </remarks>
-/// <example>
+///     <example>
+///     使用方法:
 ///     <code>
 ///  <![CDATA[
-///  BsonSerializer.RegisterSerializer(new TimeOnlySerializerAsString());
+///    BsonSerializer.RegisterSerializer(new TimeOnlySerializerAsString());
 ///   ]]>
 ///  </code>
-/// </example>
+///     </example>
+/// </remarks>
+/// </summary>
+/// <param name="format">格式化的格式</param>
 public sealed class TimeOnlySerializerAsString(string format = "HH:mm:ss") : StructSerializerBase<TimeOnly>
 {
     private readonly StringSerializer InnerSerializer = new();
@@ -39,7 +40,6 @@ public override TimeOnly Deserialize(BsonDeserializationContext context, BsonDes
 
 /// <summary>
 /// <see cref="TimeOnly" /> 序列化方式,使用Ticks来记录时间
-/// </summary>
 /// <remarks>
 ///     <para>
 ///     注意同一类型的序列化方案全局只允许注册一种.也就是说 <see cref="TimeOnlySerializerAsString" /> 和 <see cref="TimeOnlySerializerAsTicks" /> 会冲突.
@@ -52,6 +52,7 @@ public override TimeOnly Deserialize(BsonDeserializationContext context, BsonDes
 ///   ]]>
 ///  </code>
 /// </example>
+/// </summary>
 public sealed class TimeOnlySerializerAsTicks : StructSerializerBase<TimeOnly>
 {
     private readonly Int64Serializer InnerSerializer = new();