完善注释

McEyes · Jan 23, 2021 · e3c9ca9 · e3c9ca9
1 parent 5dd1586
commit e3c9ca9
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/...lientCore.Extensions.SourceGenerator/DependencyInjection/WebApiClientBuilderExtensions.cs b/...lientCore.Extensions.SourceGenerator/DependencyInjection/WebApiClientBuilderExtensions.cs
@@ -12,6 +12,13 @@ public static class WebApiClientBuilderExtensions
         /// 编译时使用SourceGenerator生成接口的代理类型代码
         /// 运行时查找接口的代理类型并创建实例
         /// </summary>
+        /// <remarks>
+        /// <para>• 要求Visual Studio或msbuild工具为最新版本才支持SourceGenerator技术</para>
+        /// <para>• 要求声明http接口的项目必须引用WebApiClientCore.Extensions.SourceGenerator包</para>
+        /// <para>• 目前SourceGenerator技术不支持partial分散在多个cs文件的单个http接口</para>
+        /// <para>• 目前SourceGenerator技术只支持c#语言</para>
+        /// <para>• 使用SourceGenerator相比Emit创建代理类并不能带来性能提升</para>
+        /// </remarks>
         /// <param name="builder"></param>
         /// <returns></returns>
         public static IWebApiClientBuilder UseSourceGeneratorHttpApiActivator(this IWebApiClientBuilder builder)