refactor(Options): 移除HelpTextAttribute及相关使用

AlianBlank · AlianBlank · commit 81da61f74391 · 2025-11-04T19:47:58.000+08:00
移除不再使用的HelpTextAttribute类，并清理所有相关测试和示例代码中对HelpTextAttribute的引用。这些帮助文本信息将由其他方式提供，简化了选项属性的配置结构。
diff --git a/GameFrameX.Foundation.Options/Attributes/HelpTextAttribute.cs b/GameFrameX.Foundation.Options/Attributes/HelpTextAttribute.cs
diff --git a/GameFrameX.Foundation.Options/OptionsDebugger.cs b/GameFrameX.Foundation.Options/OptionsDebugger.cs
@@ -39,13 +39,13 @@ public static void PrintParsedOptions<T>(T options) where T : class
 
                 // 计算最大显示宽度
                 int maxWidth = 0;
-                var optionInfos = new List<(PropertyInfo property, string displayName, Attributes.OptionAttribute optionAttribute, Attributes.HelpTextAttribute helpTextAttribute)>();
+            var optionInfos = new List<(PropertyInfo property, string displayName, Attributes.OptionAttribute optionAttribute)>();
 
                 foreach (var property in properties.OrderBy(p => p.Name))
                 {
                     var attributes = property.GetCustomAttributes(true);
                     var optionAttribute = attributes.OfType<Attributes.OptionAttribute>().FirstOrDefault();
-                    var helpTextAttribute = attributes.OfType<Attributes.HelpTextAttribute>().FirstOrDefault();
+                
 
                     string displayName;
                     if (optionAttribute != null)
@@ -59,7 +59,7 @@ public static void PrintParsedOptions<T>(T options) where T : class
                     }
 
                     maxWidth = Math.Max(maxWidth, displayName.Length);
-                    optionInfos.Add((property, displayName, optionAttribute, helpTextAttribute));
+                optionInfos.Add((property, displayName, optionAttribute));
                 }
 
                 // 添加2个字符的缓冲空间
@@ -75,15 +75,15 @@ public static void PrintParsedOptions<T>(T options) where T : class
                 int defaultWidth = DefaultValueHeader.Length;
                 int helpWidth = HelpTextHeader.Length;
 
-                foreach (var (property, displayName, optionAttribute, helpTextAttribute) in optionInfos)
+            foreach (var (property, displayName, optionAttribute) in optionInfos)
                 {
                     var value = property.GetValue(options);
                     var displayValue = FormatPropertyValue(value) ?? string.Empty;
                     var typeName = GetFriendlyTypeName(property.PropertyType) ?? string.Empty;
                     var required = optionAttribute != null ? (optionAttribute.Required ? RequiredYesLabel : RequiredNoLabel) : string.Empty;
                     var description = optionAttribute != null ? (optionAttribute.Description ?? NoDescriptionLabel) : NoOptionAttributeLabel;
                     var defaultVal = optionAttribute?.DefaultValue?.ToString() ?? string.Empty;
-                    var helpText = helpTextAttribute?.HelpText ?? string.Empty;
+                var helpText = string.Empty;
 
                     nameWidth = Math.Max(nameWidth, displayName.Length);
                     valueWidth = Math.Max(valueWidth, displayValue.Length);
diff --git a/GameFrameX.Foundation.Tests/Options/AttributeOptionsTests.cs b/GameFrameX.Foundation.Tests/Options/AttributeOptionsTests.cs
@@ -12,19 +12,15 @@ public class AttributeOptionsTests
     private class TestOptions
     {
         [Option("port", DefaultValue = 8080, EnvironmentVariable = "TEST_PORT")]
-        [HelpText("应用程序监听的端口")]
         public int Port { get; set; }
 
         [Option(LongName = "host", EnvironmentVariable = "TEST_HOST", DefaultValue = "localhost")]
-        [HelpText("应用程序主机名")]
         public string Host { get; set; }
 
         [FlagOption(LongName = "verbose")]
-        [HelpText("是否启用详细日志")]
         public bool Verbose { get; set; }
 
         [Option(LongName = "api-key", Required = true)]
-        [HelpText("API密钥")]
         public string ApiKey { get; set; }
 
         public string NoAttributeProperty { get; set; } = "默认值";
@@ -33,7 +29,6 @@ private class TestOptions
     private class TestOptionsWithMultipleAttributes
     {
         [Option("connection-string", EnvironmentVariable = "TEST_CONNECTION", Required = true)]
-        [HelpText("数据库连接字符串")]
         public string ConnectionString { get; set; }
     }
 
diff --git a/GameFrameX.Foundation.Tests/Options/Demos/AdvancedFeaturesDemo.cs b/GameFrameX.Foundation.Tests/Options/Demos/AdvancedFeaturesDemo.cs
@@ -50,103 +50,90 @@ public class AdvancedFeaturesDemoConfig
         /// 应用程序名称（必需）
         /// </summary>
         [OptionAttribute("app-name", Required = true)]
-        [HelpTextAttribute("应用程序的名称，用于标识应用")]
         public string AppName { get; set; } = string.Empty;
 
         /// <summary>
         /// 服务器主机地址
         /// </summary>
         [OptionAttribute("host", DefaultValue = "localhost")]
         [EnvironmentVariableAttribute("SERVER_HOST")]
-        [HelpTextAttribute("服务器主机地址，支持IP地址或域名")]
         public string Host { get; set; } = "localhost";
 
         /// <summary>
         /// 服务器端口号
         /// </summary>
         [OptionAttribute("port", DefaultValue = 8080)]
         [EnvironmentVariableAttribute("SERVER_PORT")]
-        [HelpTextAttribute("服务器监听端口号，范围1-65535")]
         public int Port { get; set; } = 8080;
 
         /// <summary>
         /// 是否启用SSL
         /// </summary>
         [FlagOptionAttribute("ssl")]
         [EnvironmentVariableAttribute("ENABLE_SSL")]
-        [HelpTextAttribute("启用SSL/TLS加密连接")]
         public bool EnableSsl { get; set; } = false;
 
         /// <summary>
         /// 日志级别（枚举类型）
         /// </summary>
         [OptionAttribute("log-level", DefaultValue = LogLevel.Info)]
         [EnvironmentVariableAttribute("LOG_LEVEL")]
-        [HelpTextAttribute("日志记录级别：Debug, Info, Warning, Error, Fatal")]
         public LogLevel LogLevel { get; set; } = LogLevel.Info;
 
         /// <summary>
         /// 超时时间（浮点数类型）
         /// </summary>
         [OptionAttribute("timeout", DefaultValue = 30.5)]
         [EnvironmentVariableAttribute("REQUEST_TIMEOUT")]
-        [HelpTextAttribute("请求超时时间，单位为秒，支持小数")]
         public double Timeout { get; set; } = 30.5;
 
         /// <summary>
         /// 启动时间（日期时间类型）
         /// </summary>
         [OptionAttribute("start-time")]
         [EnvironmentVariableAttribute("START_TIME")]
-        [HelpTextAttribute("应用启动时间，格式：yyyy-MM-dd HH:mm:ss")]
         public DateTime? StartTime { get; set; }
 
         /// <summary>
         /// 应用程序GUID
         /// </summary>
         [OptionAttribute("app-id")]
         [EnvironmentVariableAttribute("APP_ID")]
-        [HelpTextAttribute("应用程序唯一标识符（GUID格式）")]
         public Guid? AppId { get; set; }
 
         /// <summary>
         /// 数据库连接字符串（必需）
         /// </summary>
         [OptionAttribute("database-url", Required = true)]
         [EnvironmentVariableAttribute("DATABASE_URL")]
-        [HelpTextAttribute("数据库连接字符串，必须提供")]
         public string DatabaseUrl { get; set; } = string.Empty;
 
         /// <summary>
         /// API密钥（可选）
         /// </summary>
         [OptionAttribute("api-key")]
         [EnvironmentVariableAttribute("API_KEY")]
-        [HelpTextAttribute("第三方API访问密钥，可选")]
         public string? ApiKey { get; set; }
 
         /// <summary>
         /// 最大连接数（可空整数）
         /// </summary>
         [OptionAttribute("max-connections", DefaultValue = 100)]
         [EnvironmentVariableAttribute("MAX_CONNECTIONS")]
-        [HelpTextAttribute("最大并发连接数，默认100")]
         public int? MaxConnections { get; set; } = 100;
 
         /// <summary>
         /// 缓存大小（十进制数）
         /// </summary>
         [OptionAttribute("cache-size", DefaultValue = 256.5)]
         [EnvironmentVariableAttribute("CACHE_SIZE")]
-        [HelpTextAttribute("缓存大小，单位MB，支持小数")]
         public decimal CacheSize { get; set; } = 256.5m;
 
         /// <summary>
         /// 是否启用调试模式（可空布尔值）
         /// </summary>
         [FlagOptionAttribute("debug")]
         [EnvironmentVariableAttribute("DEBUG")]
-        [HelpTextAttribute("启用调试模式，显示详细日志")]
         public bool? Debug { get; set; }
     }
 
diff --git a/GameFrameX.Foundation.Tests/Options/Demos/BasicUsageDemo.cs b/GameFrameX.Foundation.Tests/Options/Demos/BasicUsageDemo.cs
@@ -56,7 +56,6 @@ public class BasicDemoConfig
         /// </summary>
         [OptionAttribute("database-url", Description = "xxxxxxxxxxxxxxxxxdsakfjhjhjakfhj 温热欻穿oquikocxkzuisaanmsaioajkdjsa开双冲akjhjkfjaok返矿卡健康返矿桑吉很但恐韩克很检控方炯看就肯斯的就看妇科琅丹福斯翻看东街口翻开三即可"
         )]
-        [HelpText("数据库连接字符串, 例如: \"Server=localhost;Port=3306;Database=test;Uid=root;Pwd=123456;\"")]
         [EnvironmentVariableAttribute("DATABASE_URL")]
         public string? DatabaseUrl { get; set; }
     }

Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,6 @@ public class BasicDemoConfig`
`56`	`56`	`/// </summary>`
`57`	`57`	`[OptionAttribute("database-url", Description = "xxxxxxxxxxxxxxxxxdsakfjhjhjakfhj 温热欻穿oquikocxkzuisaanmsaioajkdjsa开双冲akjhjkfjaok返矿卡健康返矿桑吉很但恐韩克很检控方炯看就肯斯的就看妇科琅丹福斯翻看东街口翻开三即可"`
`58`	`58`	`)]`
`59`		`- [HelpText("数据库连接字符串, 例如: \"Server=localhost;Port=3306;Database=test;Uid=root;Pwd=123456;\"")]`
`60`	`59`	`[EnvironmentVariableAttribute("DATABASE_URL")]`
`61`	`60`	`public string? DatabaseUrl { get; set; }`
`62`	`61`	`}`