doc(Comments): update components documentation (#7741)

* refactor: 更正单词拼写错误

* doc: 更新注释

* doc: 调整注释文本

* doc: 增加注释文档

* doc: 更新注释

* refactor: 精简注释

* doc: 完善注释

* doc: 更新注释文档

Author: ArgoZhang

src/BootstrapBlazor.Server/Components/Samples/Breadcrumbs.razor

@@ -8,3 +8,5 @@
 <DemoBlock Title="@Localizer["Block1Title"]" Introduction="@Localizer["Block1Intro"]" Name="Normal">
     <Breadcrumb Value="@DataSource" />
 </DemoBlock>
+
+<AttributeTable Type="typeof(Breadcrumb)" />

src/BootstrapBlazor/Components/AutoFill/AutoFill.razor.cs

@@ -169,18 +169,10 @@ public partial class AutoFill<TValue>
 
     private string? _lastClientValue;
 
-    /// <summary>
-    /// <para lang="zh">获得 组件样式</para>
-    /// <para lang="en">Gets the component style</para>
-    /// </summary>
     private string? ClassString => CssBuilder.Default("auto-complete auto-fill")
         .AddClass("is-clearable", IsClearable)
         .Build();
 
-    /// <summary>
-    /// <para lang="zh">获得 清除图标样式</para>
-    /// <para lang="en">Gets the clear icon class string</para>
-    /// </summary>
     private string? ClearClassString => CssBuilder.Default("clear-icon")
         .AddClass($"text-{Color.ToDescriptionString()}", Color != Color.None)
         .AddClass($"text-success", IsValid.HasValue && IsValid.Value)
@@ -251,17 +243,8 @@ public void TriggerChange(string v)
 
     private bool IsNullable() => !ValueType.IsValueType || NullableUnderlyingType != null;
 
-    /// <summary>
-    /// <para lang="zh">获得 是否显示清除按钮</para>
-    /// <para lang="en">Gets whether show the clear button</para>
-    /// </summary>
     private bool GetClearable() => IsClearable && !IsDisabled && IsNullable();
 
-    /// <summary>
-    /// <para lang="zh">点击候选项目时回调方法</para>
-    /// <para lang="en">Callback method when a candidate item is clicked</para>
-    /// </summary>
-    /// <param name="val"><para lang="zh">点击项的值</para><para lang="en">The value of the clicked item</para></param>
     private async Task OnClickItem(TValue val)
     {
         CurrentValue = val;

src/BootstrapBlazor/Components/Input/BootstrapInputBase.cs

@@ -6,14 +6,14 @@
 namespace BootstrapBlazor.Components;
 
 /// <summary>
-/// <para lang="zh">Base class for BootstrapInput components</para>
+/// <para lang="zh">Input 组件基类</para>
 /// <para lang="en">Base class for BootstrapInput components</para>
 /// </summary>
 [BootstrapModuleAutoLoader("Input/BootstrapInput.razor.js", JSObjectReference = true, AutoInvokeInit = false)]
 public abstract class BootstrapInputBase<TValue> : ValidateBase<TValue>
 {
     /// <summary>
-    /// <para lang="zh">获得 the class attribute value</para>
+    /// <para lang="zh">获得 class 属性值</para>
     /// <para lang="en">Gets the class attribute value</para>
     /// </summary>
     protected virtual string? ClassName => CssBuilder.Default("form-control")
@@ -22,77 +22,77 @@ public abstract class BootstrapInputBase<TValue> : ValidateBase<TValue>
         .Build();
 
     /// <summary>
-    /// <para lang="zh">获得/设置 the placeholder attribute value</para>
+    /// <para lang="zh">获得/设置 占位符属性值</para>
     /// <para lang="en">Gets or sets the placeholder attribute value</para>
     /// </summary>
     [Parameter]
     public string? PlaceHolder { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 the 回调方法 for Enter key press, default is null</para>
+    /// <para lang="zh">获得/设置 回车键按下时的回调方法，默认值为 null</para>
     /// <para lang="en">Gets or sets the callback method for Enter key press, default is null</para>
     /// </summary>
     [Parameter]
     public Func<TValue, Task>? OnEnterAsync { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 the 回调方法 for Esc key press, default is null</para>
+    /// <para lang="zh">获得/设置 Esc 键按下时的回调方法，默认值为 null</para>
     /// <para lang="en">Gets or sets the callback method for Esc key press, default is null</para>
     /// </summary>
     [Parameter]
     public Func<TValue, Task>? OnEscAsync { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 the 按钮 颜色</para>
+    /// <para lang="zh">获得/设置 按钮颜色</para>
     /// <para lang="en">Gets or sets the button color</para>
     /// </summary>
     [Parameter]
     public Color Color { get; set; } = Color.None;
 
     /// <summary>
-    /// <para lang="zh">获得/设置 the formatter function</para>
+    /// <para lang="zh">获得/设置 格式化函数</para>
     /// <para lang="en">Gets or sets the formatter function</para>
     /// </summary>
     [Parameter]
     public Func<TValue?, string>? Formatter { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 the format string, e.g., "yyyy-MM-dd" for date 类型s</para>
+    /// <para lang="zh">获得/设置 格式字符串，例如 "yyyy-MM-dd" 用于日期类型</para>
     /// <para lang="en">Gets or sets the format string, e.g., "yyyy-MM-dd" for date types</para>
     /// </summary>
     [Parameter]
     public string? FormatString { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 是否 to automatically focus, default is false</para>
+    /// <para lang="zh">获得/设置 是否自动获取焦点，默认值为 false</para>
     /// <para lang="en">Gets or sets whether to automatically focus, default is false</para>
     /// </summary>
     [Parameter]
     public bool IsAutoFocus { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 是否 to automatically select all text on focus, default is false</para>
+    /// <para lang="zh">获得/设置 是否在获取焦点时自动选择所有文本，默认值为 false</para>
     /// <para lang="en">Gets or sets whether to automatically select all text on focus, default is false</para>
     /// </summary>
     [Parameter]
     public bool IsSelectAllTextOnFocus { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 是否 to automatically select all text on Enter key press, default is false</para>
+    /// <para lang="zh">获得/设置 是否在按下回车键时自动选择所有文本，默认值为 false</para>
     /// <para lang="en">Gets or sets whether to automatically select all text on Enter key press, default is false</para>
     /// </summary>
     [Parameter]
     public bool IsSelectAllTextOnEnter { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 是否 to automatically trim whitespace, default is false</para>
+    /// <para lang="zh">获得/设置 是否自动去除空格，默认值为 false</para>
     /// <para lang="en">Gets or sets whether to automatically trim whitespace, default is false</para>
     /// </summary>
     [Parameter]
     public bool IsTrim { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 the 回调方法 for blur event, default is null</para>
+    /// <para lang="zh">获得/设置 失去焦点时的回调方法，默认值为 null</para>
     /// <para lang="en">Gets or sets the callback method for blur event, default is null</para>
     /// </summary>
     [Parameter]
@@ -102,25 +102,25 @@ public abstract class BootstrapInputBase<TValue> : ValidateBase<TValue>
     private Modal? Modal { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得 the input 类型, default is "text"</para>
-    /// <para lang="en">Gets the input type, default is "text"</para>
+    /// <para lang="zh">获得/设置 输入框类型，默认值为 "text"</para>
+    /// <para lang="en">Gets or sets the input type, default is "text"</para>
     /// </summary>
     protected string Type { get; set; } = "text";
 
     /// <summary>
-    /// <para lang="zh">Method to focus the element</para>
+    /// <para lang="zh">聚焦元素方法</para>
     /// <para lang="en">Method to focus the element</para>
     /// </summary>
     public async Task FocusAsync() => await InvokeVoidAsync("focus", GetInputId());
 
     /// <summary>
-    /// <para lang="zh">Method to select all text</para>
+    /// <para lang="zh">选择所有文本方法</para>
     /// <para lang="en">Method to select all text</para>
     /// </summary>
     public async ValueTask SelectAllTextAsync() => await InvokeVoidAsync("select", Id);
 
     /// <summary>
-    /// <para lang="zh">获得/设置 是否 to skip JS script registration for Enter/Esc key handling, default is false</para>
+    /// <para lang="zh">获得/设置 是否跳过 Enter/Esc 键处理的 JS 脚本注册，默认值为 false</para>
     /// <para lang="en">Gets or sets whether to skip JS script registration for Enter/Esc key handling, default is false</para>
     /// </summary>
     protected bool SkipRegisterEnterEscJSInvoke { get; set; }
@@ -182,13 +182,13 @@ protected override async Task OnAfterRenderAsync(bool firstRender)
     }
 
     /// <summary>
-    /// <para lang="zh">获得 the input element Id</para>
+    /// <para lang="zh">获得输入元素的 Id</para>
     /// <para lang="en">Gets the input element Id</para>
     /// </summary>
     protected virtual string? GetInputId() => Id;
 
     /// <summary>
-    /// <para lang="zh">Value formatting 委托 method</para>
+    /// <para lang="zh">值格式化委托方法</para>
     /// <para lang="en">Value formatting delegate method</para>
     /// </summary>
     /// <param name="value"></param>
@@ -199,16 +199,16 @@ protected override async Task OnAfterRenderAsync(bool firstRender)
             : base.FormatValueAsString(value));
 
     /// <summary>
-    /// <para lang="zh">TryParseValueFromString</para>
-    /// <para lang="en">TryParseValueFromString</para>
+    /// <para lang="zh">尝试从字符串解析值</para>
+    /// <para lang="en">Tries to parse a value from a string</para>
     /// </summary>
     /// <param name="value"></param>
     /// <param name="result"></param>
     /// <param name="validationErrorMessage"></param>
     protected override bool TryParseValueFromString(string value, [MaybeNullWhen(false)] out TValue result, out string? validationErrorMessage) => base.TryParseValueFromString(IsTrim ? value.Trim() : value, out result, out validationErrorMessage);
 
     /// <summary>
-    /// <para lang="zh">OnBlur method</para>
+    /// <para lang="zh">OnBlur 方法</para>
     /// <para lang="en">OnBlur method</para>
     /// </summary>
     protected virtual async Task OnBlur()
@@ -220,7 +220,7 @@ protected virtual async Task OnBlur()
     }
 
     /// <summary>
-    /// <para lang="zh">Client-side EnterCallback method</para>
+    /// <para lang="zh">客户端 EnterCallback 方法</para>
     /// <para lang="en">Client-side EnterCallback method</para>
     /// </summary>
     [JSInvokable]
@@ -233,7 +233,7 @@ public async Task EnterCallback()
     }
 
     /// <summary>
-    /// <para lang="zh">Client-side EscCallback method</para>
+    /// <para lang="zh">客户端 EscCallback 方法</para>
     /// <para lang="en">Client-side EscCallback method</para>
     /// </summary>
     [JSInvokable]
@@ -246,8 +246,7 @@ public async Task EscCallback()
     }
 
     /// <summary>
-    /// <para lang="zh"><inheritdoc /></para>
-    /// <para lang="en"><inheritdoc /></para>
+    /// <inheritdoc/>
     /// </summary>
     /// <param name="disposing"></param>
     protected override async ValueTask DisposeAsync(bool disposing)

src/BootstrapBlazor/Components/Input/OtpInput.razor.cs

@@ -6,35 +6,35 @@
 namespace BootstrapBlazor.Components;
 
 /// <summary>
-/// <para lang="zh">OTP input component</para>
+/// <para lang="zh">OTP 输入组件</para>
 /// <para lang="en">OTP input component</para>
 /// </summary>
 [BootstrapModuleAutoLoader("Input/OtpInput.razor.js", JSObjectReference = true)]
 public partial class OtpInput
 {
     /// <summary>
-    /// <para lang="zh">获得/设置 the length of the OTP input. 默认为 6</para>
+    /// <para lang="zh">获得/设置 OTP 输入的长度。默认为 6</para>
     /// <para lang="en">Gets or sets the length of the OTP input. Default is 6</para>
     /// </summary>
     [Parameter]
     public int Digits { get; set; } = 6;
 
     /// <summary>
-    /// <para lang="zh">获得/设置 是否 the OTP input is readonly. 默认为 false</para>
+    /// <para lang="zh">获得/设置 OTP 输入是否只读。默认为 false</para>
     /// <para lang="en">Gets or sets whether the OTP input is readonly. Default is false</para>
     /// </summary>
     [Parameter]
     public bool IsReadonly { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 the value 类型 of the OTP input. 默认为 <see cref="OtpInputType.Number"/></para>
+    /// <para lang="zh">获得/设置 OTP 输入的值类型。默认为 <see cref="OtpInputType.Number"/></para>
     /// <para lang="en">Gets or sets the value type of the OTP input. Default is <see cref="OtpInputType.Number"/></para>
     /// </summary>
     [Parameter]
     public OtpInputType Type { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 the placeholder of the OTP input. 默认为 null</para>
+    /// <para lang="zh">获得/设置 OTP 输入的占位符。默认为 null</para>
     /// <para lang="en">Gets or sets the placeholder of the OTP input. Default is null</para>
     /// </summary>
     [Parameter]
@@ -103,7 +103,7 @@ protected override void OnParametersSet()
     }
 
     /// <summary>
-    /// <para lang="zh">Trigger value changed event 回调. Trigger by JavaScript</para>
+    /// <para lang="zh">触发值更改事件回调。由 JavaScript 触发</para>
     /// <para lang="en">Trigger value changed event callback. Trigger by JavaScript</para>
     /// </summary>
     /// <param name="val"></param>

src/BootstrapBlazor/Components/Layout/Layout.razor.cs

@@ -520,8 +520,8 @@ public partial class Layout : ITabHeader
     public IEnumerable<string>? ExcludeUrls { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 Gets or sets a collection of additional assemblies that should be searched for components that can match URIs</para>
-    /// <para lang="en">Gets or sets Gets or sets a collection of additional assemblies that should be searched for components that can match URIs</para>
+    /// <para lang="zh">获得/设置 额外的程序集集合，这些程序集将被搜索以匹配 URI 的组件</para>
+    /// <para lang="en">Gets or sets a collection of additional assemblies that should be searched for components that can match URIs</para>
     /// </summary>
     [Parameter]
     public IEnumerable<Assembly>? AdditionalAssemblies { get; set; }

src/BootstrapBlazor/Components/Logout/Logout.razor.cs

@@ -81,7 +81,7 @@ public partial class Logout
     public RenderFragment? LinkTemplate { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 the avatar border radius. 默认为 null</para>
+    /// <para lang="zh">获得/设置 组件头像边框圆角 默认 null 未设置</para>
     /// <para lang="en">Gets or sets the avatar border radius. Default is null</para>
     /// </summary>
     [Parameter]

src/BootstrapBlazor/Utils/CssBuilder.cs

@@ -15,7 +15,7 @@ namespace BootstrapBlazor.Components;
 public class CssBuilder
 {
     private readonly StringBuilder _builder = new();
-    private bool _hasConent;
+    private bool _hasContent;
 
     /// <summary>
     /// <para lang="zh">创建一个 CssBuilder 实例，用于定义组件中使用的条件 CSS 类。调用 Build() 返回完整的 CSS 类字符串</para>
@@ -40,7 +40,7 @@ protected CssBuilder(string? value)
         if (!string.IsNullOrEmpty(value))
         {
             _builder.Append(value);
-            _hasConent = true;
+            _hasContent = true;
         }
     }
 
@@ -60,13 +60,13 @@ public CssBuilder AddClass(string? value)
     {
         if (!string.IsNullOrEmpty(value))
         {
-            if (_hasConent)
+            if (_hasContent)
             {
                 _builder.Append(' ');
             }
             else
             {
-                _hasConent = true;
+                _hasContent = true;
             }
             _builder.Append(value);
         }
@@ -233,5 +233,5 @@ public CssBuilder AddStyleFromAttributes(IDictionary<string, object>? additional
     ///  <para lang="zh">完成的 CSS 类字符串</para>
     ///  <para lang="en">Completed CSS Classes as a string</para>
     /// </returns>
-    public string? Build() => _hasConent ? _builder.ToString() : null;
+    public string? Build() => _hasContent ? _builder.ToString() : null;
 }