Skip to content

Commit a5b1537

Browse files
authored
doc(Comments): update components xml comments (#7745)
* doc: 更新注释文档 * doc: 更新注释文档 * doc(MaskService): 更新注释文档 * doc(Menu): 更新注释文档
1 parent e039a8f commit a5b1537

File tree

6 files changed

+45
-40
lines changed

6 files changed

+45
-40
lines changed

src/BootstrapBlazor/Components/Marquee/Marquee.razor.cs

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,54 +7,50 @@ namespace BootstrapBlazor.Components;
77

88
/// <summary>
99
/// <para lang="zh">Marquee 字幕滚动组件</para>
10-
/// <para lang="en">Marquee 字幕滚动component</para>
10+
/// <para lang="en">Marquee scrolling component</para>
1111
/// </summary>
1212
public partial class Marquee
1313
{
1414
/// <summary>
1515
/// <para lang="zh">获得/设置 组件值 显示文本 默认 Empty</para>
16-
/// <para lang="en">Gets or sets component值 display文本 Default is Empty</para>
16+
/// <para lang="en">Gets or sets the component's display text. Default is Empty.</para>
1717
/// </summary>
1818
[Parameter]
1919
public string? Text { get; set; }
2020

2121
/// <summary>
22-
/// <para lang="zh">获得/设置 组件值 文本颜色 默认 #000 <para>支持16进制和颜色名称</para>
23-
///</para>
24-
/// <para lang="en">Gets or sets component值 文本color Default is #000 <para>支持16进制和color名称</para>
25-
///</para>
22+
/// <para lang="zh">获得/设置 组件值 文本颜色 默认 #000 支持16进制和颜色名称</para>
23+
/// <para lang="en">Gets or sets the component's text color. Default is #000 Supports hexadecimal and color names</para>
2624
/// </summary>
2725
[Parameter]
2826
public string Color { get; set; } = "#000";
2927

3028
/// <summary>
31-
/// <para lang="zh">获得/设置 组件值 背景颜色 默认 #fff <para>支持16进制和颜色名称</para>
32-
///</para>
33-
/// <para lang="en">Gets or sets component值 背景color Default is #fff <para>支持16进制和color名称</para>
34-
///</para>
29+
/// <para lang="zh">获得/设置 组件值 背景颜色 默认 #fff 支持16进制和颜色名称</para>
30+
/// <para lang="en">Gets or sets the component's background color. Default is #fff Supports hexadecimal and color names</para>
3531
/// </summary>
3632
[Parameter]
3733
public string BackgroundColor { get; set; } = "#fff";
3834

3935
/// <summary>
4036
/// <para lang="zh">获得/设置 组件值 文本大小 默认 72px</para>
41-
/// <para lang="en">Gets or sets component值 文本大小 Default is 72px</para>
37+
/// <para lang="en">Gets or sets the component's text size. Default is 72px</para>
4238
/// </summary>
4339
[Parameter]
4440
public int FontSize { get; set; } = 72;
4541

4642
/// <summary>
4743
/// <para lang="zh">获得/设置 组件值 动画时间 默认 14s <para>值越小滚动越快</para>
4844
///</para>
49-
/// <para lang="en">Gets or sets component值 动画时间 Default is 14s <para>值越小滚动越快</para>
45+
/// <para lang="en">Gets or sets the component's animation duration. Default is 14s <para>The smaller the value, the faster the scroll</para>
5046
///</para>
5147
/// </summary>
5248
[Parameter]
5349
public int Duration { get; set; } = 14;
5450

5551
/// <summary>
5652
/// <para lang="zh">获得/设置 组件值 滚动方向 默认 LeftToRight</para>
57-
/// <para lang="en">Gets or sets component值 滚动方向 Default is LeftToRight</para>
53+
/// <para lang="en">Gets or sets the component's scroll direction. Default is LeftToRight</para>
5854
/// </summary>
5955
[Parameter]
6056
public MarqueeDirection Direction { get; set; }

src/BootstrapBlazor/Components/Mask/MaskService.cs

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,36 @@ namespace BootstrapBlazor.Components;
77

88
/// <summary>
99
/// <para lang="zh">MaskService 遮罩服务</para>
10-
/// <para lang="en">MaskService</para>
10+
/// <para lang="en">MaskService Mask Service</para>
1111
/// </summary>
1212
public class MaskService : BootstrapServiceBase<MaskOption?>
1313
{
1414
/// <summary>
1515
/// <para lang="zh">显示 Mask 方法</para>
1616
/// <para lang="en">Show Mask Method</para>
1717
/// </summary>
18-
/// <param name="option"><para lang="zh">遮罩配置信息实体类</para><para lang="en">Mask Configuration Information Entity Class</para></param>
19-
/// <param name="mask"><para lang="zh"><see cref="Mask"/> 组件实例</para><para lang="en"><see cref="Mask"/> Component Instance</para></param>
18+
/// <param name="option">
19+
/// <para lang="zh">遮罩配置信息实体类</para>
20+
/// <para lang="en">Mask Configuration Information Entity Class</para>
21+
/// </param>
22+
/// <param name="mask">
23+
/// <para lang="zh"><see cref="Mask"/> 组件实例</para>
24+
/// <para lang="en"><see cref="Mask"/> Component Instance</para>
25+
/// </param>
2026
public Task Show(MaskOption option, Mask? mask = null) => Invoke(option, mask);
2127

2228
/// <summary>
2329
/// <para lang="zh">关闭 Mask 方法</para>
2430
/// <para lang="en">Close Mask Method</para>
2531
/// </summary>
26-
/// <param name="mask"><para lang="zh"><see cref="Mask"/> 组件实例</para><para lang="en"><see cref="Mask"/> Component Instance</para></param>
27-
/// <param name="all"><para lang="zh">是否关闭所有遮罩 默认 false 仅关闭当前或者指定遮罩</para><para lang="en">Whether to close all masks. Default false. Only close current or specified mask</para></param>
32+
/// <param name="mask">
33+
/// <para lang="zh"><see cref="Mask"/> 组件实例</para>
34+
/// <para lang="en"><see cref="Mask"/> Component Instance</para>
35+
/// </param>
36+
/// <param name="all">
37+
/// <para lang="zh">是否关闭所有遮罩 默认 false 仅关闭当前或者指定遮罩</para>
38+
/// <para lang="en">Whether to close all masks. Default false. Only close current or specified mask</para>
39+
/// </param>
2840
public async Task Close(Mask? mask = null, bool all = false)
2941
{
3042
if (all)

src/BootstrapBlazor/Components/Menu/Menu.razor.cs

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ public partial class Menu
4848
/// <para lang="en">Gets or sets Whether it is accordion effect. Default false</para>
4949
/// </summary>
5050
/// <remarks>
51-
/// <para lang="zh">启用此功能时 <see cref="IsExpandAll" /> 参数不生效</para>
52-
/// <para lang="en"><see cref="IsExpandAll" /> parameter does not take effect when this feature is enabled</para>
51+
/// <para lang="zh">启用此功能时 <see cref="IsExpandAll" /> 参数不生效</para>
52+
/// <para lang="en"><see cref="IsExpandAll" /> parameter does not take effect when this feature is enabled</para>
5353
/// </remarks>
5454
[Parameter]
5555
public bool IsAccordion { get; set; }
@@ -59,8 +59,8 @@ public partial class Menu
5959
/// <para lang="en">Gets or sets Whether to expand all. Default false</para>
6060
/// </summary>
6161
/// <remarks>
62-
/// <para lang="zh">手风琴效果 <see cref="IsAccordion" /> 时此参数不生效</para>
63-
/// <para lang="en">This parameter does not take effect when accordion effect <see cref="IsAccordion" /> is enabled</para>
62+
/// <para lang="zh">手风琴效果 <see cref="IsAccordion" /> 时此参数不生效</para>
63+
/// <para lang="en">This parameter does not take effect when accordion effect <see cref="IsAccordion" /> is enabled</para>
6464
/// </remarks>
6565
[Parameter]
6666
public bool IsExpandAll { get; set; }
@@ -76,7 +76,6 @@ public partial class Menu
7676
/// <para lang="zh">获得/设置 侧栏垂直模式 默认 false</para>
7777
/// <para lang="en">Gets or sets Sidebar vertical mode. Default false</para>
7878
/// </summary>
79-
/// <value></value>
8079
[Parameter]
8180
public bool IsVertical { get; set; }
8281

src/BootstrapBlazor/Components/Menu/MenuItem.cs

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,18 @@ public MenuItem() { }
5959
/// <para lang="zh">带参数构造函数</para>
6060
/// <para lang="en">Parameterized Constructor</para>
6161
/// </summary>
62-
/// <param name="text"><para lang="zh">显示文本</para><para lang="en">Display Text</para></param>
63-
/// <param name="url"><para lang="zh">菜单地址</para><para lang="en">Menu Url</para></param>
64-
/// <param name="icon"><para lang="zh">菜单图标</para><para lang="en">Menu Icon</para></param>
62+
/// <param name="text">
63+
/// <para lang="zh">显示文本</para>
64+
/// <para lang="en">Display Text</para>
65+
/// </param>
66+
/// <param name="url">
67+
/// <para lang="zh">菜单地址</para>
68+
/// <para lang="en">Menu Url</para>
69+
/// </param>
70+
/// <param name="icon">
71+
/// <para lang="zh">菜单图标</para>
72+
/// <para lang="en">Menu Icon</para>
73+
/// </param>
6574
public MenuItem(string text, string? url = null, string? icon = null)
6675
{
6776
Text = text;

src/BootstrapBlazor/Components/Menu/SubMenu.razor.cs

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
namespace BootstrapBlazor.Components;
99

1010
/// <summary>
11-
/// <para lang="zh"></para>
12-
/// <para lang="en"></para>
11+
/// <para lang="zh">子菜单组件内部使用不推荐直接使用此组件</para>
12+
/// <para lang="en">SubMenu component for internal use only. Direct usage is not recommended.</para>
1313
/// </summary>
1414
public sealed partial class SubMenu
1515
{
@@ -67,11 +67,6 @@ public sealed partial class SubMenu
6767
[NotNull]
6868
private IStringLocalizer<Menu>? Localizer { get; set; }
6969

70-
/// <summary>
71-
/// <para lang="zh">获得 样式字符串</para>
72-
/// <para lang="en">Get Style String</para>
73-
/// </summary>
74-
/// <param name="item"></param>
7570
private static string? GetClassString(MenuItem item) => CssBuilder.Default()
7671
.AddClass("active", !item.IsDisabled && item.IsActive)
7772
.AddClass("disabled", item.IsDisabled)

src/BootstrapBlazor/Components/Message/Message.razor.cs

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,9 @@ public partial class Message
3333
[Parameter]
3434
public Placement Placement { get; set; } = Placement.Top;
3535

36-
/// <summary>
37-
/// <para lang="zh">ToastServices 服务实例</para>
38-
/// <para lang="en">MessageService Service Instance</para>
39-
/// </summary>
4036
[Inject]
4137
[NotNull]
42-
public MessageService? MessageService { get; set; }
38+
private MessageService? MessageService { get; set; }
4339

4440
/// <summary>
4541
/// <inheritdoc/>
@@ -92,7 +88,6 @@ protected override async Task OnAfterRenderAsync(bool firstRender)
9288
/// <para lang="zh">设置 容器位置方法</para>
9389
/// <para lang="en">Set Container Placement Method</para>
9490
/// </summary>
95-
/// <param name="placement"></param>
9691
public void SetPlacement(Placement placement)
9792
{
9893
Placement = placement;
@@ -134,7 +129,6 @@ public void Clear(string id)
134129
/// <para lang="zh">OnDismiss 回调方法 由 JSInvoke 触发</para>
135130
/// <para lang="en">OnDismiss Callback Method. Triggered by JSInvoke</para>
136131
/// </summary>
137-
/// <param name="id"></param>
138132
[JSInvokable]
139133
public async ValueTask Dismiss(string id)
140134
{

0 commit comments

Comments
 (0)