doc(Xml): update component comment (#7654)

ArgoZhang · web-flow · commit b568e89c9c77 · 2026-02-11T14:22:06.000+08:00
* doc: 更新注释文本

* doc: 更新注释信息

* doc: 更新注释信息

* chore: 更新 MainLayout 资源文件

* doc: 移除 App Localizer

* chore: 更新资源文件
diff --git a/src/BootstrapBlazor.Server/Components/App.razor b/src/BootstrapBlazor.Server/Components/App.razor
@@ -1,5 +1,4 @@
 @inject IWebHostEnvironment Env
-@inject IStringLocalizer<BaseLayout> Localizer
 @inject IOptions<WebsiteOptions> WebsiteOption
 
 <!DOCTYPE html>
diff --git a/src/BootstrapBlazor.Server/Components/Layout/MainLayout.razor b/src/BootstrapBlazor.Server/Components/Layout/MainLayout.razor
@@ -1,4 +1,4 @@
-﻿@inherits LayoutComponentBase
+@inherits LayoutComponentBase
 @layout BaseLayout
 
 <section class="section">
@@ -39,7 +39,7 @@
                 <ThemeChooser></ThemeChooser>
             </DialButtonItem>
             <DialButtonItem>
-                <Tooltip Title="@ChatTooltip" Placement="Placement.Left" class="btn btn-circle btn-fade btn-dial-item d-flex">
+                <Tooltip Title="@UpdateTooltip" Placement="Placement.Left" class="btn btn-circle btn-fade btn-dial-item d-flex">
                     <a href="@WebsiteOption.Value.WikiUrl" target="_blank">
                         <i class="fa-solid fa-file-circle-check"></i>
                     </a>
diff --git a/src/BootstrapBlazor.Server/Components/Layout/MainLayout.razor.cs b/src/BootstrapBlazor.Server/Components/Layout/MainLayout.razor.cs
@@ -1,4 +1,4 @@
-﻿// Licensed to the .NET Foundation under one or more agreements.
+// Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the Apache 2.0 License
 // See the LICENSE file in the project root for more information.
 // Maintainer: Argo Zhang(argo@live.ca) Website: https://www.blazor.zone
@@ -26,10 +26,10 @@ public partial class MainLayout : IDisposable
 
     [Inject]
     [NotNull]
-    private IStringLocalizer<BaseLayout>? Localizer { get; set; }
+    private IStringLocalizer<MainLayout>? Localizer { get; set; }
 
     [NotNull]
-    private string? Title { get; set; }
+    private string? UpdateTooltip { get; set; }
 
     [NotNull]
     private string? ChatTooltip { get; set; }
@@ -43,7 +43,7 @@ protected override void OnInitialized()
 
         DispatchService.Subscribe(Dispatch);
 
-        Title ??= Localizer[nameof(Title)];
+        UpdateTooltip ??= Localizer[nameof(UpdateTooltip)];
         ChatTooltip ??= Localizer[nameof(ChatTooltip)];
     }
 
diff --git a/src/BootstrapBlazor.Server/Locales/en-US.json b/src/BootstrapBlazor.Server/Locales/en-US.json
@@ -144,6 +144,10 @@
     "FooterLi1": "Slider verification code",
     "FriendLink": "Links"
   },
+  "BootstrapBlazor.Server.Components.Layout.MainLayout": {
+    "ChatTooltip": "Azure OpenAI",
+    "UpdateTooltip": "View update log"
+  },
   "BootstrapBlazor.Server.Components.Layout.NavMenu": {
     "Affix": "Affix",
     "Ajax": "Ajax",
diff --git a/src/BootstrapBlazor.Server/Locales/zh-CN.json b/src/BootstrapBlazor.Server/Locales/zh-CN.json
@@ -144,6 +144,10 @@
     "FooterLi1": "滑块验证码",
     "FriendLink": "友情链接"
   },
+  "BootstrapBlazor.Server.Components.Layout.MainLayout": {
+    "ChatTooltip": "Azure OpenAI",
+    "UpdateTooltip": "点击查看更新日志"
+  },
   "BootstrapBlazor.Server.Components.Layout.NavMenu": {
     "Affix": "固钉组件 Affix",
     "Ajax": "数据传输 Ajax",
diff --git a/src/BootstrapBlazor/Components/EditorForm/EditorItem.cs b/src/BootstrapBlazor/Components/EditorForm/EditorItem.cs
@@ -28,20 +28,19 @@ public class EditorItem<TModel, TValue> : ComponentBase, IEditorItem
     [Parameter]
     public EventCallback<TValue> FieldChanged { get; set; }
 
-    /// <summary>
-    /// <para lang="zh">获得/设置 属性类型</para>
-    /// <para lang="en">Gets or sets the property type</para>
-    /// </summary>
-    [NotNull]
-    public Type? PropertyType { get; set; }
-
     /// <summary>
     /// <para lang="zh">获得/设置 ValueExpression 表达式</para>
     /// <para lang="en">Gets or sets the value expression</para>
     /// </summary>
     [Parameter]
     public Expression<Func<TValue>>? FieldExpression { get; set; }
 
+    /// <summary>
+    /// <inheritdoc cref="IEditorItem.PropertyType"/>
+    /// </summary>
+    [NotNull]
+    public Type? PropertyType { get; set; }
+
     /// <summary>
     /// <inheritdoc cref="IEditorItem.Editable"/>
     /// </summary>
@@ -51,70 +50,61 @@ public class EditorItem<TModel, TValue> : ComponentBase, IEditorItem
     public bool Editable { get; set; } = true;
 
     /// <summary>
-    /// <para lang="zh">获得/设置 是否忽略显示</para>
-    /// <para lang="en">Gets or sets whether the field is ignored</para>
+    /// <inheritdoc cref="IEditorItem.Ignore"/>
     /// </summary>
     [Parameter]
     public bool? Ignore { get; set; }
 
     /// <summary>
-    /// <inheritdoc/>
+    /// <inheritdoc cref="IEditorItem.Readonly"/>
     /// </summary>
     [Parameter]
     public bool? Readonly { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 是否必填</para>
-    /// <para lang="en">Gets or sets whether the field is required</para>
+    /// <inheritdoc cref="IEditorItem.Required"/>
     /// </summary>
     [Parameter]
     public bool? Required { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 必填错误信息</para>
-    /// <para lang="en">Gets or sets the required error message</para>
+    /// <inheritdoc cref="IEditorItem.RequiredErrorMessage"/>
     /// </summary>
     [Parameter]
     public string? RequiredErrorMessage { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 是否跳过校验</para>
-    /// <para lang="en">Gets or sets whether to skip validation</para>
+    /// <inheritdoc cref="IEditorItem.SkipValidate"/>
     /// </summary>
     [Parameter]
     public bool SkipValidate { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 是否显示标签提示</para>
-    /// <para lang="en">Gets or sets whether to show the label tooltip</para>
+    /// <inheritdoc cref="IEditorItem.ShowLabelTooltip"/>
     /// </summary>
     [Parameter]
     public bool? ShowLabelTooltip { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 显示文本</para>
-    /// <para lang="en">Gets or sets the display text</para>
+    /// <inheritdoc cref="IEditorItem.Text"/>
     /// </summary>
     [Parameter]
     public string? Text { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 步长</para>
-    /// <para lang="en">Gets or sets the step value</para>
+    /// <inheritdoc cref="IEditorItem.Step"/>
     /// </summary>
     [Parameter]
     public string? Step { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 行数</para>
-    /// <para lang="en">Gets or sets the row count</para>
+    /// <inheritdoc cref="IEditorItem.Rows"/>
     /// </summary>
     [Parameter]
     public int Rows { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 列数</para>
-    /// <para lang="en">Gets or sets the column count</para>
+    /// <inheritdoc cref="IEditorItem.Cols"/>
     /// </summary>
     [Parameter]
     public int Cols { get; set; }
@@ -141,122 +131,106 @@ public class EditorItem<TModel, TValue> : ComponentBase, IEditorItem
     }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 组件类型</para>
-    /// <para lang="en">Gets or sets the component type</para>
+    /// <inheritdoc cref="IEditorItem.ComponentType"/>
     /// </summary>
     [Parameter]
     public Type? ComponentType { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 组件参数集合</para>
-    /// <para lang="en">Gets or sets the component parameters</para>
+    /// <inheritdoc cref="IEditorItem.ComponentParameters"/>
     /// </summary>
     [Parameter]
     public IEnumerable<KeyValuePair<string, object>>? ComponentParameters { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 占位符</para>
-    /// <para lang="en">Gets or sets the placeholder text</para>
+    /// <inheritdoc cref="IEditorItem.PlaceHolder"/>
     /// </summary>
     [Parameter]
     public string? PlaceHolder { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 显示顺序</para>
-    /// <para lang="en">Gets or sets the display order</para>
+    /// <inheritdoc cref="IEditorItem.Order"/>
     /// </summary>
     [Parameter]
     public int Order { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 绑定数据集合</para>
-    /// <para lang="en">Gets or sets the bound data items</para>
+    /// <inheritdoc cref="IEditorItem.Items"/>
     /// </summary>
     [Parameter]
     public IEnumerable<SelectedItem>? Items { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 Lookup 数据集合</para>
-    /// <para lang="en">Gets or sets the lookup data items</para>
+    /// <inheritdoc cref="ILookup.Lookup"/>
     /// </summary>
     [Parameter]
     public IEnumerable<SelectedItem>? Lookup { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 选择时是否显示搜索</para>
-    /// <para lang="en">Gets or sets whether to show search when selecting</para>
+    /// <inheritdoc cref="IEditorItem.ShowSearchWhenSelect"/>
     /// </summary>
     [Parameter]
     public bool ShowSearchWhenSelect { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 选择时是否固定搜索</para>
-    /// <para lang="en">Gets or sets whether the search is fixed when selecting</para>
+    /// <inheritdoc cref="IEditorItem.IsFixedSearchWhenSelect"/>
     /// </summary>
     [Parameter]
     [Obsolete("已弃用，请删除；Deprecated, please delete")]
     [ExcludeFromCodeCoverage]
     public bool IsFixedSearchWhenSelect { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 是否显示为气泡</para>
-    /// <para lang="en">Gets or sets whether to show as a popover</para>
+    /// <inheritdoc cref="IEditorItem.IsPopover"/>
     /// </summary>
     [Parameter]
     public bool IsPopover { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 Lookup 比较方式</para>
-    /// <para lang="en">Gets or sets the lookup string comparison</para>
+    /// <inheritdoc cref="ILookup.LookupStringComparison"/>
     /// </summary>
     [Parameter]
     public StringComparison LookupStringComparison { get; set; } = StringComparison.OrdinalIgnoreCase;
 
     /// <summary>
-    /// <para lang="zh">获得/设置 Lookup 服务键</para>
-    /// <para lang="en">Gets or sets the lookup service key</para>
+    /// <inheritdoc cref="ILookup.LookupServiceKey"/>
     /// </summary>
     [Parameter]
     public string? LookupServiceKey { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 Lookup 服务数据</para>
-    /// <para lang="en">Gets or sets the lookup service data</para>
+    /// <inheritdoc cref="ILookup.LookupServiceData"/>
     /// </summary>
     [Parameter]
     public object? LookupServiceData { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 Lookup 服务实例</para>
-    /// <para lang="en">Gets or sets the lookup service instance</para>
+    /// <inheritdoc cref="ILookup.LookupService"/>
     /// </summary>
     [Parameter]
     public ILookupService? LookupService { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 校验规则集合</para>
-    /// <para lang="en">Gets or sets the validation rules</para>
+    /// <inheritdoc cref="IEditorItem.ValidateRules"/>
     /// </summary>
     [Parameter]
     public List<IValidator>? ValidateRules { get; set; }
 
-    [CascadingParameter]
-    private List<IEditorItem>? EditorItems { get; set; }
-
     /// <summary>
-    /// <para lang="zh">获得/设置 分组名称</para>
-    /// <para lang="en">Gets or sets the group name</para>
+    /// <inheritdoc cref="IEditorItem.GroupName"/>
     /// </summary>
     [Parameter]
     public string? GroupName { get; set; }
 
     /// <summary>
-    /// <para lang="zh">获得/设置 分组顺序</para>
-    /// <para lang="en">Gets or sets the group order</para>
+    /// <inheritdoc cref="IEditorItem.GroupOrder"/>
     /// </summary>
     [Parameter]
     public int GroupOrder { get; set; }
 
+    [CascadingParameter]
+    private List<IEditorItem>? EditorItems { get; set; }
+
     /// <summary>
     /// <inheritdoc/>
     /// </summary>
@@ -276,14 +250,12 @@ protected override void OnInitialized()
     private FieldIdentifier? _fieldIdentifier;
 
     /// <summary>
-    /// <para lang="zh">获得显示名称</para>
-    /// <para lang="en">Gets the display name</para>
+    /// <inheritdoc cref="IEditorItem.GetDisplayName"/>
     /// </summary>
     public virtual string GetDisplayName() => Text ?? _fieldIdentifier?.GetDisplayName() ?? string.Empty;
 
     /// <summary>
-    /// <para lang="zh">获得字段名称</para>
-    /// <para lang="en">Gets the field name</para>
+    /// <inheritdoc cref="IEditorItem.GetFieldName"/>
     /// </summary>
     public string GetFieldName() => _fieldIdentifier?.FieldName ?? string.Empty;
 }
diff --git a/src/BootstrapBlazor/Components/ValidateForm/ValidateForm.razor.cs b/src/BootstrapBlazor/Components/ValidateForm/ValidateForm.razor.cs
diff --git a/src/BootstrapBlazor/Extensions/ExceptionExtensions.cs b/src/BootstrapBlazor/Extensions/ExceptionExtensions.cs

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`@inject IWebHostEnvironment Env`
`2`		`-@inject IStringLocalizer<BaseLayout> Localizer`
`3`	`2`	`@inject IOptions<WebsiteOptions> WebsiteOption`
`4`	`3`
`5`	`4`	`<!DOCTYPE html>`