拼写错误检查

Author: xljiulang

WebApiClientCore.Abstractions/ApiDataTypeDescriptor.cs

@@ -23,7 +23,7 @@ public abstract class ApiDataTypeDescriptor
         public abstract bool IsRawStream { get; protected set; }
 
         /// <summary>
-        /// 获取是否为原始类型的byte[]
+        /// 获取是否为原始类型的 byte[]
         /// </summary>
         public abstract bool IsRawByteArray { get; protected set; }
 

WebApiClientCore.Abstractions/Contexts/ApiRequestContext.cs

@@ -9,7 +9,7 @@ namespace WebApiClientCore
     public class ApiRequestContext
     {
         /// <summary>
-        /// 获取http上下文
+        /// 获取 http 上下文
         /// </summary>
         public HttpContext HttpContext { get; }
 

WebApiClientCore.Abstractions/Contexts/HttpContext.cs

@@ -5,7 +5,7 @@
 namespace WebApiClientCore
 {
     /// <summary>
-    /// 表示http上下文
+    /// 表示 http 上下文
     /// </summary>
     public class HttpContext : HttpClientContext
     {

WebApiClientCore.Abstractions/HttpApiOptions.cs

@@ -17,7 +17,7 @@ public class HttpApiOptions
     {
         /// <summary>
         /// 获取或设置Http服务完整主机域名
-        /// 例如http://www.abc.com/或http://www.abc.com/path/
+        /// 例如 http://www.abc.com/ 或 http://www.abc.com/path/
         /// 设置了HttpHost值，HttpHostAttribute将失效
         /// </summary>
         public Uri? HttpHost { get; set; }
@@ -45,12 +45,12 @@ public class HttpApiOptions
 
 
         /// <summary>
-        /// 获取json序列化选项
+        /// 获取 json 序列化选项
         /// </summary>
         public JsonSerializerOptions JsonSerializeOptions { get; } = CreateJsonSerializeOptions();
 
         /// <summary>
-        /// 获取json反序列化选项
+        /// 获取 json 反序列化选项
         /// </summary>
         public JsonSerializerOptions JsonDeserializeOptions { get; } = CreateJsonDeserializeOptions();
 
@@ -65,7 +65,7 @@ public class HttpApiOptions
         public XmlReaderSettings XmlDeserializeOptions { get; } = new XmlReaderSettings();
 
         /// <summary>
-        /// 获取keyValue序列化选项
+        /// 获取 keyValue 序列化选项
         /// </summary>
         public KeyValueSerializerOptions KeyValueSerializeOptions { get; } = new KeyValueSerializerOptions();
 

WebApiClientCore.Abstractions/HttpApiRequestMessage.cs

@@ -8,12 +8,12 @@
 namespace WebApiClientCore
 {
     /// <summary>
-    /// 表示httpApi的请求消息
+    /// 表示 httpApi 的请求消息
     /// </summary>
     public abstract class HttpApiRequestMessage : HttpRequestMessage
     {
         /// <summary>
-        /// 返回使用uri值合成的请求URL
+        /// 返回使用 uri 值合成的请求URL
         /// </summary> 
         /// <param name="uri">uri值</param> 
         /// <returns></returns>
@@ -29,7 +29,7 @@ public abstract class HttpApiRequestMessage : HttpRequestMessage
 
         /// <summary>
         /// 添加字段到已有的Content
-        /// 要求content-type为application/x-www-form-urlencoded
+        /// 要求 content-type 为 application/x-www-form-urlencoded
         /// </summary>
         /// <param name="name">名称</param>
         /// <param name="value">值</param> 
@@ -42,7 +42,7 @@ public async Task AddFormFieldAsync(string name, string? value)
 
         /// <summary>
         /// 添加字段到已有的Content
-        /// 要求content-type为application/x-www-form-urlencoded
+        /// 要求 content-type 为 application/x-www-form-urlencoded
         /// </summary>
         /// <param name="keyValues">键值对</param>
         /// <exception cref="NotSupportedException"></exception>
@@ -52,7 +52,7 @@ public async Task AddFormFieldAsync(string name, string? value)
 
         /// <summary>
         /// 添加文本内容到已有的Content
-        /// 要求content-type为multipart/form-data
+        /// 要求 content-type 为 multipart/form-data
         /// </summary>     
         /// <param name="name">名称</param>
         /// <param name="value">文本</param> 
@@ -64,14 +64,14 @@ public void AddFormDataText(string name, string? value)
 
         /// <summary>
         /// 添加文本内容到已有的Content
-        /// 要求content-type为multipart/form-data
+        /// 要求 content-type 为 multipart/form-data
         /// </summary>     
         /// <param name="keyValues">键值对</param> 
         public abstract void AddFormDataText(IEnumerable<KeyValue> keyValues);
 
         /// <summary>
         /// 添加文件内容到已有的Content
-        /// 要求content-type为multipart/form-data
+        /// 要求 content-type 为 multipart/form-data
         /// </summary>
         /// <param name="stream">文件流</param>
         /// <param name="name">名称</param>

WebApiClientCore.Abstractions/IDataCollection.cs

@@ -13,7 +13,7 @@ public interface IDataCollection
         int Count { get; }
 
         /// <summary>
-        /// 返回是否包含指定的key
+        /// 返回是否包含指定的 key
         /// </summary>
         /// <param name="key">键</param>
         /// <returns></returns>
@@ -28,7 +28,7 @@ public interface IDataCollection
 
         /// <summary>
         /// 读取指定的键并尝试转换为目标类型
-        /// 失败则返回目标类型的default值
+        /// 失败则返回目标类型的 default 值
         /// </summary>
         /// <typeparam name="TValue"></typeparam>
         /// <param name="key">键</param>

WebApiClientCore.Abstractions/Serialization/KeyValueSerializerOptions.cs

@@ -14,7 +14,7 @@ namespace WebApiClientCore.Serialization
     public sealed class KeyValueSerializerOptions : KeyNamingOptions
     {
         /// <summary>
-        /// 包装的jsonOptions
+        /// 包装的 jsonOptions
         /// </summary>
         [DebuggerBrowsable(DebuggerBrowsableState.Never)]
         private readonly JsonSerializerOptions jsonOptions;
@@ -37,7 +37,7 @@ public JsonNamingPolicy? DictionaryKeyPolicy
         }
 
         /// <summary>
-        /// 获取或设置是否忽略null值
+        /// 获取或设置是否忽略 null 值
         /// </summary>
         public bool IgnoreNullValues
         {

WebApiClientCore.Analyzers/Descriptors.cs

@@ -28,7 +28,7 @@ static class Descriptors
         /// <summary>
         /// 非方法声明诊断描述器
         /// </summary>
-        public static DiagnosticDescriptor NotMethodDefindedDescriptor { get; }
+        public static DiagnosticDescriptor NotMethodDefendedDescriptor { get; }
             = Create("WA1004", Resx.WA1004_title, Resx.WA1004_message);
 
         /// <summary>

WebApiClientCore.Analyzers/HttpApiContext.cs

@@ -84,14 +84,14 @@ public static bool TryParse(SyntaxNodeAnalysisContext syntaxNodeContext, out Htt
                 return false;
             }
 
-            var ihttpApi = syntaxNodeContext.Compilation.GetTypeByMetadataName(IHttpApiTypeName);
-            if (ihttpApi == null)
+            var httpApi = syntaxNodeContext.Compilation.GetTypeByMetadataName(IHttpApiTypeName);
+            if (httpApi == null)
             {
                 return false;
             }
 
-            var iapiAttribute = syntaxNodeContext.Compilation.GetTypeByMetadataName(IApiAttributeTypeName);
-            if (IsHttpApiInterface(@interface, ihttpApi, iapiAttribute) == false)
+            var apiAttribute = syntaxNodeContext.Compilation.GetTypeByMetadataName(IApiAttributeTypeName);
+            if (IsHttpApiInterface(@interface, httpApi, apiAttribute) == false)
             {
                 return false;
             }
@@ -105,27 +105,27 @@ public static bool TryParse(SyntaxNodeAnalysisContext syntaxNodeContext, out Htt
         }
 
         /// <summary>
-        /// 是否为http接口
+        /// 是否为 http 接口
         /// </summary>
         /// <param name="interface"></param>
-        /// <param name="ihttpApi"></param>
-        /// <param name="iapiAttribute"></param>
+        /// <param name="httpApi"></param>
+        /// <param name="apiAttribute"></param>
         /// <returns></returns>
-        private static bool IsHttpApiInterface(INamedTypeSymbol @interface, INamedTypeSymbol ihttpApi, INamedTypeSymbol? iapiAttribute)
+        private static bool IsHttpApiInterface(INamedTypeSymbol @interface, INamedTypeSymbol httpApi, INamedTypeSymbol? apiAttribute)
         {
-            if (@interface.AllInterfaces.Contains(ihttpApi))
+            if (@interface.AllInterfaces.Contains(httpApi))
             {
                 return true;
             }
 
-            if (iapiAttribute == null)
+            if (apiAttribute == null)
             {
                 return false;
             }
 
             return @interface.AllInterfaces.Append(@interface).Any(i =>
-                HasAttribute(i, iapiAttribute) || i.GetMembers().OfType<IMethodSymbol>().Any(m =>
-                HasAttribute(m, iapiAttribute) || m.Parameters.Any(p => HasAttribute(p, iapiAttribute))));
+                HasAttribute(i, apiAttribute) || i.GetMembers().OfType<IMethodSymbol>().Any(m =>
+                HasAttribute(m, apiAttribute) || m.Parameters.Any(p => HasAttribute(p, apiAttribute))));
         }
 
 

WebApiClientCore.Analyzers/HttpApiDiagnosticAnalyzer.cs

@@ -25,7 +25,7 @@ public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics
                     Descriptors.AttributeDescriptor,
                     Descriptors.ReturnTypeDescriptor,
                     Descriptors.RefParameterDescriptor,
-                    Descriptors.NotMethodDefindedDescriptor,
+                    Descriptors.NotMethodDefendedDescriptor,
                     Descriptors.GenericMethodDescriptor,
                     Descriptors.UriAttributeDescriptor,
                     Descriptors.ModifierDescriptor,
@@ -70,7 +70,7 @@ private IEnumerable<HttpApiDiagnosticProvider> GetDiagnosticProviders(HttpApiCon
             yield return new CtorAttributeDiagnosticProvider(context);
             yield return new ReturnTypeDiagnosticProvider(context);
             yield return new RefParameterDiagnosticProvider(context);
-            yield return new NotMethodDefindedDiagnosticProvider(context);
+            yield return new NotMethodDefendedDiagnosticProvider(context);
             yield return new GenericMethodDiagnosticProvider(context);
             yield return new UriAttributeDiagnosticProvider(context);
             yield return new ModifierDiagnosticProvider(context);