feat(docstring):添加部分docstring (#376)

* feat(docstring):添加docstring

Signed-off-by: doudou0720 <98651603+doudou0720@users.noreply.github.com>

* fix(docstring):修复部分docstring格式错误

Signed-off-by: doudou0720 <98651603+doudou0720@users.noreply.github.com>

* fix(docstring):修复部分docstring

Signed-off-by: doudou0720 <98651603+doudou0720@users.noreply.github.com>

* chore(Docstring):MW_* 前14

* chore(Docstring):MW_* part 2

* chore(Docstring):MW_* part 3

* chore:优化缩进

* fix: 修复数学计算中的潜在除零错误和数值稳定性问题

Signed-off-by: doudou0720 <98651603+doudou0720@users.noreply.github.com>

* chore:删除Rebase时多余的OOBE函数

* chore: 更新代码注释和文档格式

修复XML文档注释中的格式问题,统一使用<c>和<see>标签
更新ConfigHelper类的预留说明,明确未来扩展用途
优化TimerDisplayDate_Elapsed方法的注释,说明UI异步更新机制
合并重复的注释摘要行,提高文档可读性
添加形状识别功能的64位进程限制说明
修正视频呈现器设备选择逻辑的文档说明

* chore(IPPTLinkManager): 更新TryEndSlideShow方法的XML注释格式

* chore: 修正代码注释中的术语和格式问题

更新多个文件中的XML注释,统一使用<see langword="..."/>标记代替<c>...</c>标记
规范术语使用(如"延迟初始化"代替"懒惰初始化")
修正注释中的格式错误和补充说明
调整代码区域的注释对齐格式

---------

Signed-off-by: doudou0720 <98651603+doudou0720@users.noreply.github.com>
This commit is contained in:
doudou0720
2026-02-22 10:14:12 +08:00
committed by GitHub
parent 3e3db27296
commit 656863a7d0
48 changed files with 6220 additions and 192 deletions
@@ -17,6 +17,12 @@ namespace Ink_Canvas.Windows
{
private MainWindow _mainWindow;
/// <summary>
/// 初始化设置窗口的 UI、事件和面板并加载初始状态与主题。
/// </summary>
/// <remarks>
/// 构造函数完成以下工作:获取主窗口引用,注册搜索与菜单事件,构建并绑定侧栏条目,挂接各设置面板的滚动/阴影事件,初始化面板数组、滚动容器、标题与名称映射,设置初始选中项与主题状态,为自定义滑块添加触摸支持,预加载所有面板设置,并多次应用主题以确保视觉元素正确呈现(包含延迟再应用以修正标题栏等)。
/// </remarks>
public SettingsWindow()
{
InitializeComponent();
@@ -322,8 +328,11 @@ namespace Ink_Canvas.Windows
}
/// <summary>
/// 通知所有面板应用主题
/// 通知所有已注册的设置面板应用当前主题配置,使各面板更新其视觉样式以匹配窗口主题。
/// </summary>
/// <remarks>
/// 对每个面板尝试通过反射调用其 `ApplyTheme` 方法;如果某面板不存在该方法则会跳过,调用过程中发生的异常会被捕获并写入调试输出,但不会中断对其它面板的处理。
/// </remarks>
private void ApplyThemeToAllPanels()
{
try
@@ -753,8 +762,12 @@ namespace Ink_Canvas.Windows
}
/// <summary>
/// 加载所有设置面板的设置
/// 加载并初始化所有设置面板:对每个面板尝试加载设置、启用触摸支持并应用当前主题。
/// </summary>
/// <remarks>
/// 该操作在 UI 线程上以 DispatcherPriority.Loaded 异步调度执行,并在完成后再次触发对所有面板的主题应用以确保视觉状态一致。
/// 对单个面板的初始化错误会被捕获并处理,不会中断其它面板的预加载流程。
/// </remarks>
private void LoadAllPanelsSettings()
{
try
@@ -938,6 +951,16 @@ namespace Ink_Canvas.Windows
public string[] SettingsPaneTitles;
public string[] SettingsPaneNames;
/// <summary>
/// 根据当前选中的侧边栏项更新侧边栏条目状态、面板可见性与主题并将视图滚动到顶部。
/// </summary>
/// <remarks>
/// - 将 SidebarItems 中的 Selected 与 SettingsWindowTitle.Text 与字段 _selectedSidebarItemName 同步;
/// - 根据应用设置计算并同步每个 SidebarItem 的 IsDarkTheme
/// - 切换各个面板(Pane)的 Visibility,仅显示与 _selectedSidebarItemName 对应的面板;
/// - 异步调用所选面板(若存在)的 ApplyTheme 方法以确保新显示面板使用正确主题;
/// - 将所有已注册的 SettingsPaneScrollViewers 滚动到顶部以重置视图位置。
/// </remarks>
public void UpdateSidebarItemsSelection()
{
foreach (var si in SidebarItems)
@@ -1815,4 +1838,4 @@ namespace Ink_Canvas.Windows
#endregion
}
}
}