Skip to content

Commit 1f79baf

Browse files
authored
doc(Comment): update commnet of components (#7596)
* doc: 更新抽屉组件注释 * doc: 更新注释文档
1 parent e160cd8 commit 1f79baf

File tree

2 files changed

+23
-27
lines changed

2 files changed

+23
-27
lines changed

src/BootstrapBlazor/Components/DragDrap/DragDropService.cs

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,48 +6,52 @@
66
namespace BootstrapBlazor.Components;
77

88
/// <summary>
9-
/// <para lang="zh">拖拽服务</para>
10-
/// <para lang="en">Drag Drop Service</para>
9+
/// <para lang="zh">DragDropService 拖拽服务</para>
10+
/// <para lang="en">DragDropService component</para>
1111
/// </summary>
1212
/// <typeparam name="T"></typeparam>
1313
internal class DragDropService<T>
1414
{
1515
/// <summary>
16-
/// <para lang="zh">活动的Item</para>
17-
/// <para lang="en">Active Item</para>
16+
/// <para lang="zh">获得/设置 活动的Item</para>
17+
/// <para lang="en">Gets or sets Active Item</para>
1818
/// </summary>
1919
public T? ActiveItem { get; set; }
2020

2121
/// <summary>
22-
/// <para lang="zh">悬停的项目</para>
23-
/// <para lang="en">Drag Target Item</para>
22+
/// <para lang="zh">获得/设置 悬停的项目</para>
23+
/// <para lang="en">Gets or sets Drag Target Item</para>
2424
/// </summary>
2525
public T? DragTargetItem { get; set; }
2626

2727
/// <summary>
28-
/// <para lang="zh">被拖拽的Items</para>
29-
/// <para lang="en">Dragged Items</para>
28+
/// <para lang="zh">获得/设置 被拖拽的 Items</para>
29+
/// <para lang="en">Gets or sets Dragged Items</para>
3030
/// </summary>
3131
public List<T>? Items { get; set; }
3232

3333
/// <summary>
34-
/// <para lang="zh">活动的Id</para>
35-
/// <para lang="en">Active Id</para>
34+
/// <para lang="zh">获得/设置 活动的 Id</para>
35+
/// <para lang="en">Gets or sets Active Id</para>
3636
/// </summary>
3737
public int? ActiveSpacerId { get; set; }
3838

3939
/// <summary>
40-
/// <para lang="zh">之前的位置</para>
41-
/// <para lang="en">Previous Index</para>
40+
/// <para lang="zh">获得/设置 之前的位置</para>
41+
/// <para lang="en">Gets or sets Previous Index</para>
4242
/// </summary>
4343
public int? OldIndex { get; set; }
4444

4545
/// <summary>
46-
/// <para lang="zh">通知刷新</para>
47-
/// <para lang="en">Notify StateChanged</para>
46+
/// <para lang="zh">获得/设置 通知刷新方法</para>
47+
/// <para lang="en">Gets or sets Notify StateChanged</para>
4848
/// </summary>
4949
public EventHandler? StateHasChanged { get; set; }
5050

51+
/// <summary>
52+
/// <para lang="zh">重置方法</para>
53+
/// <para lang="en">Reset method</para>
54+
/// </summary>
5155
public void Reset()
5256
{
5357
if (OldIndex is >= 0 && Items != null && ActiveItem != null)
@@ -57,6 +61,10 @@ public void Reset()
5761
Commit();
5862
}
5963

64+
/// <summary>
65+
/// <para lang="zh">提交方法</para>
66+
/// <para lang="en">Commit method</para>
67+
/// </summary>
6068
public void Commit()
6169
{
6270
ActiveItem = default;

src/BootstrapBlazor/Components/Drawer/Drawer.razor.cs

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,11 @@
66
namespace BootstrapBlazor.Components;
77

88
/// <summary>
9-
/// <para lang="zh">Drawer component</para>
9+
/// <para lang="zh">Drawer 抽屉组件</para>
1010
/// <para lang="en">Drawer component</para>
1111
/// </summary>
1212
public partial class Drawer
1313
{
14-
/// <summary>
15-
/// <para lang="zh">获得 组件样式</para>
16-
/// <para lang="en">Get Component CSS Style</para>
17-
/// </summary>
1814
private string? ClassString => CssBuilder.Default("drawer collapse")
1915
.AddClass("no-bd", !ShowBackdrop)
2016
.AddClassFromAttributes(AdditionalAttributes)
@@ -26,21 +22,13 @@ public partial class Drawer
2622
.AddStyleFromAttributes(AdditionalAttributes)
2723
.Build();
2824

29-
/// <summary>
30-
/// <para lang="zh">获得 抽屉 Style 字符串</para>
31-
/// <para lang="en">Get Drawer Style String</para>
32-
/// </summary>
3325
private string? DrawerStyleString => CssBuilder.Default()
3426
.AddClass($"--bb-drawer-width: {Width};", !string.IsNullOrEmpty(Width) && !IsVertical)
3527
.AddClass($"--bb-drawer-height: {Height};", !string.IsNullOrEmpty(Height) && IsVertical)
3628
.Build();
3729

3830
private bool IsVertical => Placement == Placement.Top || Placement == Placement.Bottom;
3931

40-
/// <summary>
41-
/// <para lang="zh">获得 抽屉样式</para>
42-
/// <para lang="en">Get Drawer CSS Style</para>
43-
/// </summary>
4432
private string? DrawerClassString => CssBuilder.Default("drawer-body")
4533
.AddClass("left", Placement != Placement.Right && Placement != Placement.Top && Placement != Placement.Bottom)
4634
.AddClass("top", Placement == Placement.Top)

0 commit comments

Comments
 (0)