Merge pull request #9 from mahdidelzendeh72/develop

add comment #6
EasyMicroservices · Dec 27, 2022 · 827c6db · 827c6db
2 parents 5732499 + 3dadb77
commit 827c6db
Show file tree

Hide file tree

Showing 11 changed files with 38 additions and 29 deletions.
diff --git a/src/CSharp/EasyMicroservices.Serialization.BinaryGo/Providers/BinaryGoProvider.cs b/src/CSharp/EasyMicroservices.Serialization.BinaryGo/Providers/BinaryGoProvider.cs
@@ -6,12 +6,12 @@
 namespace EasyMicroservices.Serialization.BinaryGo.Providers
 {
     /// <summary>
-    /// 
+    /// use binary go package as binary serialization provider 
     /// </summary>
     public class BinaryGoProvider : BaseBinarySerializationProvider
     {
         /// <summary>
-        /// 
+        /// Deserialize from byte
         /// </summary>
         /// <typeparam name="T"></typeparam>
         /// <param name="reader"></param>
@@ -22,7 +22,7 @@ public override T Deserialize<T>(ReadOnlySpan<byte> reader)
         }
 
         /// <summary>
-        /// 
+        /// Serialize to byte
         /// </summary>
         /// <param name="value"></param>
         /// <returns></returns>

diff --git a/...Sharp/EasyMicroservices.Serialization.NewtonSoft.Json/Providers/NewtonsoftJsonProvider.cs b/...Sharp/EasyMicroservices.Serialization.NewtonSoft.Json/Providers/NewtonsoftJsonProvider.cs
@@ -5,12 +5,12 @@
 namespace EasyMicroservices.Serialization.Newtonsoft.Json.Providers
 {
     /// <summary>
-    /// 
+    /// use NewtonsoftJson package as text serialization provider 
     /// </summary>
     public class NewtonsoftJsonProvider : BaseTextSerializationProvider
     {
         /// <summary>
-        /// 
+        /// Deserialize from string
         /// </summary>
         /// <typeparam name="T"></typeparam>
         /// <param name="value"></param>
@@ -20,7 +20,7 @@ public override T Deserialize<T>(string value)
             return JsonConvert.DeserializeObject<T>(value);
         }
         /// <summary>
-        /// 
+        /// Serialize to string
         /// </summary>
         /// <param name="value"></param>
         /// <returns></returns>

diff --git a/...asyMicroservices.Serialization.System.Text.Json/Providers/SystemTextJsonBinaryProvider.cs b/...asyMicroservices.Serialization.System.Text.Json/Providers/SystemTextJsonBinaryProvider.cs
@@ -6,13 +6,13 @@
 namespace EasyMicroservice.Serialization.System.Text.Json.Providers
 {
     /// <summary>
-    /// /
+    ///  use mocrosoft SystemTextJson package as binary serialization provider 
     /// </summary>
 
     public class SystemTextJsonBinaryProvider : BaseBinarySerializationProvider
     {
         /// <summary>
-        /// 
+        ///  Deserialize from byte
         /// </summary>
         /// <typeparam name="T"></typeparam>
         /// <param name="reader"></param>
@@ -23,7 +23,7 @@ public override T Deserialize<T>(ReadOnlySpan<byte> reader)
             return JsonSerializer.Deserialize<T>(reader);
         }
         /// <summary>
-        /// 
+        /// Serialize to byte
         /// </summary>
         /// <param name="value"></param>
         /// <returns></returns>

diff --git a/...harp/EasyMicroservices.Serialization.System.Text.Json/Providers/SystemTextJsonProvider.cs b/...harp/EasyMicroservices.Serialization.System.Text.Json/Providers/SystemTextJsonProvider.cs
@@ -6,13 +6,12 @@
 namespace EasyMicroservice.Serialization.System.Text.Json.Providers
 {
     /// <summary>
-    /// 
+    ///  use mocrosoft SystemTextJson package as text serialization provider 
     /// </summary>
     public class SystemTextJsonProvider : BaseTextSerializationProvider
     {
         /// <summary>
-        /// 
-        /// </summary>
+        /// Deserialize from string        /// </summary>
         /// <typeparam name="T"></typeparam>
         /// <param name="value"></param>
         /// <returns></returns>
@@ -22,7 +21,7 @@ public override T Deserialize<T>(string value)
             return JsonSerializer.Deserialize<T>(value);
         }
         /// <summary>
-        /// 
+        /// Serialize to string
         /// </summary>
         /// <param name="value"></param>
         /// <returns></returns>

diff --git a/src/CSharp/EasyMicroservices.Serialization.Tests/Providers/BaseTextSerilizationTest.cs b/src/CSharp/EasyMicroservices.Serialization.Tests/Providers/BaseTextSerilizationTest.cs
@@ -2,9 +2,19 @@
 
 namespace EasyMicroservices.Serialization.Tests.Providers
 {
+    /// <summary>
+    /// base class for test
+    /// </summary>
     public abstract class BaseTextSerilizationTest
     {
+        /// <summary>
+        /// text serilaze provider
+        /// </summary>
         public ITextSerialization _provider { get; }
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="provider"></param>
         public BaseTextSerilizationTest(ITextSerialization provider)
         {
             _provider = provider;

diff --git a/src/CSharp/EasyMicroservices.Serialization/Interfaces/IBaseSerialization.cs b/src/CSharp/EasyMicroservices.Serialization/Interfaces/IBaseSerialization.cs
@@ -3,12 +3,12 @@
 namespace EasyMicroservices.Serialization.Interfaces
 {
     /// <summary>
-    /// 
+    /// general serialization method defines here
     /// </summary>
     public interface IBaseSerialization
     {
         /// <summary>
-        /// 
+        /// can convert check which type is supported for serialization
         /// </summary>
         /// <param name="objectType"></param>
         /// <returns></returns>

diff --git a/src/CSharp/EasyMicroservices.Serialization/Interfaces/IBinarySerialization.cs b/src/CSharp/EasyMicroservices.Serialization/Interfaces/IBinarySerialization.cs
@@ -2,18 +2,18 @@
 namespace EasyMicroservices.Serialization.Interfaces
 {
     /// <summary>
-    /// 
+    /// serializa to byte and visa versa
     /// </summary>
     public interface IBinarySerialization : IBaseSerialization
     {
         /// <summary>
-        /// 
+        /// serializa to byte array
         /// </summary>
         /// <param name="value"></param>
         /// <returns></returns>
         ReadOnlySpan<byte> Serialize(object value);
         /// <summary>
-        /// 
+        /// Deserialize from byte
         /// </summary>
         /// <typeparam name="T"></typeparam>
         /// <param name="reader"></param>

diff --git a/src/CSharp/EasyMicroservices.Serialization/Interfaces/ITextSerialization.cs b/src/CSharp/EasyMicroservices.Serialization/Interfaces/ITextSerialization.cs
@@ -1,18 +1,18 @@
 namespace EasyMicroservices.Serialization.Interfaces
 {
     /// <summary>
-    /// 
+    /// serialize to string and visa versa
     /// </summary>
     public interface ITextSerialization : IBaseSerialization
     {
         /// <summary>
-        /// 
+        /// Serialize to string
         /// </summary>
         /// <param name="value"></param>
         /// <returns></returns>
         string Serialize(object value);
         /// <summary>
-        /// 
+        /// Deserialize from string
         /// </summary>
         /// <typeparam name="T"></typeparam>
         /// <param name="value"></param>

diff --git a/src/CSharp/EasyMicroservices.Serialization/Providers/BaseBinarySerializationProvider.cs b/src/CSharp/EasyMicroservices.Serialization/Providers/BaseBinarySerializationProvider.cs
@@ -4,19 +4,19 @@
 namespace EasyMicroservices.Serialization.Providers
 {
     /// <summary>
-    /// 
+    /// base binary implimentaion
     /// </summary>
     public abstract class BaseBinarySerializationProvider : BaseProvider, IBinarySerialization
     {
         /// <summary>
-        /// 
+        /// Deserialize from byte
         /// </summary>
         /// <typeparam name="T"></typeparam>
         /// <param name="reader"></param>
         /// <returns></returns>
         public abstract T Deserialize<T>(ReadOnlySpan<byte> reader);
         /// <summary>
-        /// 
+        /// Serialize to byte
         /// </summary>
         /// <param name="value"></param>
         /// <returns></returns>

diff --git a/src/CSharp/EasyMicroservices.Serialization/Providers/BaseProvider.cs b/src/CSharp/EasyMicroservices.Serialization/Providers/BaseProvider.cs
@@ -4,12 +4,12 @@
 namespace EasyMicroservices.Serialization.Providers
 {
     /// <summary>
-    /// 
+    /// general serialization method defines here
     /// </summary>
     public abstract class BaseProvider : IBaseSerialization
     {
         /// <summary>
-        /// 
+        /// can convert check which type is supported for serialization
         /// </summary>
         /// <param name="objectType"></param>
         /// <returns></returns>

diff --git a/src/CSharp/EasyMicroservices.Serialization/Providers/BaseTextSerializationProvider.cs b/src/CSharp/EasyMicroservices.Serialization/Providers/BaseTextSerializationProvider.cs
@@ -4,21 +4,21 @@
 namespace EasyMicroservices.Serialization.Providers
 {
     /// <summary>
-    /// 
+    ///  base string implimentaion
     /// </summary>
     public abstract class BaseTextSerializationProvider : BaseProvider, ITextSerialization
     {
 
         /// <summary>
-        /// 
+        /// Deserialize from string
         /// </summary>
         /// <typeparam name="T"></typeparam>
         /// <param name="value"></param>
         /// <returns></returns>
         /// <exception cref="NotImplementedException"></exception>
         public abstract T Deserialize<T>(string value);
         /// <summary>
-        /// 
+        /// Serialize to string
         /// </summary>
         /// <param name="value"></param>
         /// <returns></returns>