doc(Component): update component comment (#7540)

* doc: 增加 version 信息

* refactor: 补充 version 信息

* doc: 完善注释信息

* doc: 更新示例

* chore: 增加脚本

* chore: 更新注释

* chore: 更新注释

* doc: 更新类注释

Author: ArgoZhang

src/BootstrapBlazor.Server/Directory.Build.targets

@@ -14,4 +14,12 @@
     <Copy SourceFiles="@(XmlDocsToCopy)" DestinationFolder="$(PublishDir)" SkipUnchangedFiles="true" Condition="Exists('%(RootDir)%(Directory)%(Filename)%(Extension)')" />
   </Target>
 
+  <Target Name="CopyXmlDocs2" BeforeTargets="Build">
+    <ItemGroup>
+      <XmlDocsToCopy Include="%(Reference.RelativeDir)BootstrapBlazor*.xml" />
+    </ItemGroup>
+    <Message Text="Copying XML docs to output path: $(OutputPath)" Importance="High" />
+    <Copy SourceFiles="@(XmlDocsToCopy)" DestinationFolder="$(OutputPath)" SkipUnchangedFiles="true" Condition="Exists('%(RootDir)%(Directory)%(Filename)%(Extension)')" />
+  </Target>
+  
 </Project>

src/BootstrapBlazor.Server/Locales/en-US.json

@@ -2385,7 +2385,7 @@
     "Att4": "Date format string The default is yyyyy-MM-dd",
     "Att6": "Whether to disable False by default",
     "Att8": "The value of the component is a two-way binding with ValueChanged",
-    "Att9": "Get/Set Component display mode The default is the month-to-day display mode",
+    "Att9": "Gets or sets Component display mode The default is the month-to-day display mode",
     "AttrAutoClose": "Whether auto close the popup window",
     "AttrIsEditable": "Is manual date entry allowed",
     "Event1": "Confirm that the button calls back the delegate",
@@ -3606,9 +3606,9 @@
     "CollapsibleHeaderTemplateIntro": "Setting <code>HeaderTemplate</code> for custom <code>CardHeader</code>",
     "ShadowTitle": "Shadow effect",
     "ShadowIntro": "Enable shadow effect by set <code>IsShadow</code> to true",
-    "BodyTemplate": "Get/set up BodyTemplate",
-    "FooterTemplate": "Get/set up FooterTemplate",
-    "HeaderTemplate": "Get/set up HeaderTemplate",
+    "BodyTemplate": "Gets or sets up BodyTemplate",
+    "FooterTemplate": "Gets or sets up FooterTemplate",
+    "HeaderTemplate": "Gets or sets up HeaderTemplate",
     "Class": "Style",
     "Color": "Set the color of the card border",
     "IsCenter": "Make align center by set IsCenter to true",

src/BootstrapBlazor/Components/Circle/Circle.razor.cs

@@ -13,21 +13,21 @@ public sealed partial class Circle
 {
     /// <summary>
     /// <para lang="zh">获得/设置 当前值</para>
-    /// <para lang="en">Get/Set current value</para>
+    /// <para lang="en">Gets or sets current value</para>
     /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public int Value { get; set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 当前进度值</para>
-    /// <para lang="en">Get/Set current progress value</para>
+    /// <para lang="en">Gets or sets current progress value</para>
     /// </summary>
     private string? ValueString => $"{Math.Round(((1 - Value * 1.0 / 100) * CircleLength), 2)}";
 
     /// <summary>
     /// <para lang="zh">获得/设置 Title 字符串</para>
-    /// <para lang="en">Get/Set Title string</para>
+    /// <para lang="en">Gets or sets Title string</para>
     /// </summary>
     private string ValueTitleString => $"{Value}%";
 }

src/BootstrapBlazor/Components/Circle/CircleBase.cs

@@ -39,19 +39,19 @@ public abstract class CircleBase : BootstrapModuleComponentBase
 
     /// <summary>
     /// <para lang="zh">获得/设置 Dash 字符串</para>
-    /// <para lang="en">Get/Set Dash string</para>
+    /// <para lang="en">Gets or sets Dash string</para>
     /// </summary>
     protected string DashString => $"{CircleLength}, {CircleLength}";
 
     /// <summary>
     /// <para lang="zh">获得/设置 圆形进度半径</para>
-    /// <para lang="en">Get/Set circular progress radius</para>
+    /// <para lang="en">Gets or sets circular progress radius</para>
     /// </summary>
     protected string CircleDiameter => $"{Width / 2}";
 
     /// <summary>
     /// <para lang="zh">获得/设置 半径</para>
-    /// <para lang="en">Get/Set radius</para>
+    /// <para lang="en">Gets or sets radius</para>
     /// </summary>
     protected string CircleR => $"{Width / 2 - StrokeWidth}";
 
@@ -63,39 +63,39 @@ public abstract class CircleBase : BootstrapModuleComponentBase
 
     /// <summary>
     /// <para lang="zh">获得/设置 文件预览框宽度</para>
-    /// <para lang="en">Get/Set file preview box width</para>
+    /// <para lang="en">Gets or sets file preview box width</para>
     /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public virtual int Width { get; set; } = 120;
 
     /// <summary>
     /// <para lang="zh">获得/设置 进度条宽度 默认为 2</para>
-    /// <para lang="en">Get/Set progress bar width, default is 2</para>
+    /// <para lang="en">Gets or sets progress bar width, default is 2</para>
     /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public virtual int StrokeWidth { get; set; } = 2;
 
     /// <summary>
     /// <para lang="zh">获得/设置 组件进度条颜色</para>
-    /// <para lang="en">Get/Set component progress bar color</para>
+    /// <para lang="en">Gets or sets component progress bar color</para>
     /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public Color Color { get; set; } = Color.Primary;
 
     /// <summary>
     /// <para lang="zh">获得/设置 是否显示进度百分比 默认显示</para>
-    /// <para lang="en">Get/Set whether to show progress percentage, default is true</para>
+    /// <para lang="en">Gets or sets whether to show progress percentage, default is true</para>
     /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public bool ShowProgress { get; set; } = true;
 
     /// <summary>
     /// <para lang="zh">获得/设置 子组件</para>
-    /// <para lang="en">Get/Set child content</para>
+    /// <para lang="en">Gets or sets child content</para>
     /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]

src/BootstrapBlazor/Components/ClockPicker/ClockPicker.razor.cs

@@ -15,39 +15,39 @@ public partial class ClockPicker
 {
     /// <summary>
     /// <para lang="zh">获得/设置 样式</para>
-    /// <para lang="en">Get/Set style</para>
+    /// <para lang="en">Gets or sets style</para>
     /// </summary>
     private string? ClassString => CssBuilder.Default("bb-clock-picker")
         .AddClassFromAttributes(AdditionalAttributes)
         .Build();
 
     /// <summary>
     /// <para lang="zh">获得/设置 是否显示表盘刻度 默认 false</para>
-    /// <para lang="en">Get/Set whether to show clock scale, default is false</para>
+    /// <para lang="en">Gets or sets whether to show clock scale, default is false</para>
     /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public bool ShowClockScale { get; set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 是否显示秒 默认 true</para>
-    /// <para lang="en">Get/Set whether to show second, default is true</para>
+    /// <para lang="en">Gets or sets whether to show second, default is true</para>
     /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public bool ShowSecond { get; set; } = true;
 
     /// <summary>
     /// <para lang="zh">获得/设置 是否显示分钟 默认 true</para>
-    /// <para lang="en">Get/Set whether to show minute, default is true</para>
+    /// <para lang="en">Gets or sets whether to show minute, default is true</para>
     /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public bool ShowMinute { get; set; } = true;
 
     /// <summary>
     /// <para lang="zh">获得/设置 是否自动切换 小时、分钟、秒 自动切换 默认 true</para>
-    /// <para lang="en">Get/Set whether to automatically switch hour/minute/second, default is true</para>
+    /// <para lang="en">Gets or sets whether to automatically switch hour/minute/second, default is true</para>
     /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]

src/BootstrapBlazor/Components/Collapse/Collapse.razor.cs

@@ -46,29 +46,29 @@ public partial class Collapse
 
     /// <summary>
     /// <para lang="zh">获得/设置 CollapseItem 集合</para>
-    /// <para lang="en">Get/Set CollapseItem collection</para>
+    /// <para lang="en">Gets or sets CollapseItem collection</para>
     /// </summary>
     protected List<CollapseItem> Items { get; } = new(10);
 
     /// <summary>
     /// <para lang="zh">获得/设置 是否为手风琴效果 默认为 false</para>
-    /// <para lang="en">Get/Set whether to use accordion effect, default is false</para>
+    /// <para lang="en">Gets or sets whether to use accordion effect, default is false</para>
     /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public bool IsAccordion { get; set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 CollapseItems 模板</para>
-    /// <para lang="en">Get/Set CollapseItems template</para>
+    /// <para lang="en">Gets or sets CollapseItems template</para>
     /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public RenderFragment? CollapseItems { get; set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 CollapseItem 展开收缩时回调方法</para>
-    /// <para lang="en">Get/Set callback when CollapseItem expands or collapses</para>
+    /// <para lang="en">Gets or sets callback when CollapseItem expands or collapses</para>
     /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]

src/BootstrapBlazor/Components/Collapse/CollapseItem.cs

@@ -13,71 +13,71 @@ public class CollapseItem : BootstrapComponentBase, IDisposable
 {
     /// <summary>
     /// <para lang="zh">获得/设置 文本文字</para>
-    /// <para lang="en">Get/Set text</para>
+    /// <para lang="en">Gets or sets text</para>
     /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public string? Text { get; set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 当前状态是否收缩 默认 true</para>
-    /// <para lang="en">Get/Set whether current status is collapsed, default is true</para>
+    /// <para lang="en">Gets or sets whether current status is collapsed, default is true</para>
     /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public bool IsCollapsed { get; set; } = true;
 
     /// <summary>
     /// <para lang="zh">获得/设置 图标字符串 默认为 null</para>
-    /// <para lang="en">Get/Set icon string, default is null</para>
+    /// <para lang="en">Gets or sets icon string, default is null</para>
     /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public string? Icon { get; set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 标题颜色 默认无颜色 Color.None</para>
-    /// <para lang="en">Get/Set title color, default is Color.None</para>
+    /// <para lang="en">Gets or sets title color, default is Color.None</para>
     /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public Color TitleColor { get; set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 CSS 样式名称 默认 null</para>
-    /// <para lang="en">Get/Set CSS style name, default is null</para>
+    /// <para lang="en">Gets or sets CSS style name, default is null</para>
     /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public string? Class { get; set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 组件内容</para>
-    /// <para lang="en">Get/Set component content</para>
+    /// <para lang="en">Gets or sets component content</para>
     /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public RenderFragment? ChildContent { get; set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 Header CSS 样式名称 默认 null</para>
-    /// <para lang="en">Get/Set Header CSS style name, default is null</para>
+    /// <para lang="en">Gets or sets Header CSS style name, default is null</para>
     /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public string? HeaderClass { get; set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 组件 Header 模板</para>
-    /// <para lang="en">Get/Set component Header template</para>
+    /// <para lang="en">Gets or sets component Header template</para>
     /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public RenderFragment? HeaderTemplate { get; set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 所属 Collapse 实例</para>
-    /// <para lang="en">Get/Set the Collapse instance it belongs to</para>
+    /// <para lang="en">Gets or sets the Collapse instance it belongs to</para>
     /// </summary>
     [CascadingParameter]
     protected Collapse? Collapse { get; set; }

src/BootstrapBlazor/Components/ColorPicker/ColorPicker.razor.cs

@@ -23,31 +23,31 @@ public partial class ColorPicker
 
     /// <summary>
     /// <para lang="zh">获得/设置 显示模板</para>
-    /// <para lang="en">Get/Set display template</para>
+    /// <para lang="en">Gets or sets display template</para>
     /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public RenderFragment<string>? Template { get; set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 显示颜色值格式化回调方法</para>
-    /// <para lang="en">Get/Set display color value formatting callback method</para>
+    /// <para lang="en">Gets or sets display color value formatting callback method</para>
     /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public Func<string, Task<string>>? Formatter { get; set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 是否支持透明度 默认 false 不支持</para>
-    /// <para lang="en">Get/Set whether to support opacity, default is false(not supported)</para>
+    /// <para lang="en">Gets or sets whether to support opacity, default is false(not supported)</para>
     /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public bool IsSupportOpacity { get; set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 预设候选颜色 <see cref="IsSupportOpacity"/> 开启时生效 默认 null</para>
-    /// <para lang="en">Get/Set preset candidate colors, effective when <see cref="IsSupportOpacity"/> is enabled, default is null</para>
+    /// <para lang="en">Gets or sets preset candidate colors, effective when <see cref="IsSupportOpacity"/> is enabled, default is null</para>
     /// <para><version>10.2.2</version></para>
     /// </summary>
     /// <remarks>

src/BootstrapBlazor/Components/ConnectionHub/ConnectionItem.cs

@@ -13,26 +13,26 @@ public class ConnectionItem
 {
     /// <summary>
     /// <para lang="zh">获得/设置 连接 Id</para>
-    /// <para lang="en">Get/Set Connection Id</para>
+    /// <para lang="en">Gets or sets Connection Id</para>
     /// </summary>
     [NotNull]
     public string? Id { get; internal set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 连接 Ip 地址</para>
-    /// <para lang="en">Get/Set Connection IP address</para>
+    /// <para lang="en">Gets or sets Connection IP address</para>
     /// </summary>
     public ClientInfo? ClientInfo { get; set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 开始连接时间</para>
-    /// <para lang="en">Get/Set Connection start time</para>
+    /// <para lang="en">Gets or sets Connection start time</para>
     /// </summary>
     public DateTimeOffset ConnectionTime { get; internal set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 上次心跳时间</para>
-    /// <para lang="en">Get/Set Last beat time</para>
+    /// <para lang="en">Gets or sets Last beat time</para>
     /// </summary>
     public DateTimeOffset LastBeatTime { get; internal set; }
 }