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
+35 -3
View File
@@ -12,6 +12,11 @@ namespace Ink_Canvas.Windows
private int _currentStep = 0;
private const int MaxStepIndex = 11;
/// <summary>
/// 初始化 OobeWindow,并使用指定的 Settings 填充初始状态与界面。
/// </summary>
/// <param name="settings">用于读取和写入用户首选项的 Settings 实例。</param>
/// <exception cref="System.ArgumentNullException">当 <paramref name="settings"/> 为 null 时抛出。</exception>
public OobeWindow(Settings settings)
{
if (settings == null) throw new ArgumentNullException(nameof(settings));
@@ -26,6 +31,12 @@ namespace Ink_Canvas.Windows
UpdateStepUI();
}
/// <summary>
/// 从当前 Settings 对象将相关首选项映射并回显到各个 OOBE 界面控件中,以反映用户已保存的配置状态。
/// </summary>
/// <remarks>
/// 对各个配置分组(外观、启动、托盘、PPT、画板、手势、墨迹纠正、快捷键、崩溃处理、自动化、随机点名、高级选项、截图等)分别进行读取并更新对应控件的选中/选项状态;在初始化每个分组时会捕获并忽略异常,避免单个分组的错误影响窗口启动流程。
/// </remarks>
private void InitializeFromSettings()
{
// 根据当前设置回显遥测选项
@@ -214,6 +225,12 @@ namespace Ink_Canvas.Windows
catch (Exception ex) { System.Diagnostics.Debug.WriteLine(ex); }
}
/// <summary>
/// 将当前界面上用户的选择写回到 Settings 对象并标记已接受遥测隐私说明。
/// </summary>
/// <remarks>
/// 更新的设置包括:启动时的遥测级别、主题与启动外观、启动行为、托盘/快速面板、PowerPoint 联动、画板与墨迹选项、手势设置、墨迹纠正、鼠标模式快捷键、崩溃处理策略、自动化相关设置、随机点名设置以及高级日志选项;操作中对各子配置块采用防护性写回(局部异常被忽略)。方法结束时会将 HasAcceptedTelemetryPrivacy 置为 true。
/// </remarks>
private void ApplySelection()
{
// 将当前遥测选项写回到设置
@@ -394,6 +411,11 @@ namespace Ink_Canvas.Windows
_settings.Startup.HasAcceptedTelemetryPrivacy = true;
}
/// <summary>
/// 处理“确认/下一步”按钮的点击:在未到最后一步时前进到下一步,若已是最后一步则应用当前选择并关闭窗口。
/// </summary>
/// <param name="sender">触发事件的源对象。</param>
/// <param name="e">路由事件参数。</param>
private void BtnConfirm_Click(object sender, RoutedEventArgs e)
{
// 如果还没到最后一步,则进入下一步
@@ -410,6 +432,11 @@ namespace Ink_Canvas.Windows
Close();
}
/// <summary>
/// 导航到上一步骤;若已处于第一步(索引为 0)则不做任何操作。
/// </summary>
/// <param name="sender">触发此事件的源对象。</param>
/// <param name="e">事件的路由参数。</param>
private void BtnPreviousStep_Click(object sender, RoutedEventArgs e)
{
if (_currentStep <= 0) return;
@@ -418,8 +445,11 @@ namespace Ink_Canvas.Windows
}
/// <summary>
/// 窗口加载完成时触发淡入动画
/// 窗口加载时对窗口不透明度执行淡入动画以显示窗口
/// </summary>
/// <remarks>
/// 使用约 220 毫秒的缓出三次方缓动实现淡入;如果动画失败,方法会立即将窗口不透明度设为 1 作为回退。
/// </remarks>
private void OobeWindow_OnLoaded(object sender, RoutedEventArgs e)
{
try
@@ -445,8 +475,11 @@ namespace Ink_Canvas.Windows
}
/// <summary>
/// 根据当前步骤更新界面显示和按钮文案
/// 根据当前步骤索引更新向导界面显示对应步骤面板,播放切换动画,并刷新步骤指示、标题、子标题和按钮文本/可见性
/// </summary>
/// <remarks>
/// 若更新过程中出现异常会被捕获并忽略以避免中断主流程。
/// </remarks>
private void UpdateStepUI()
{
try
@@ -584,4 +617,3 @@ namespace Ink_Canvas.Windows
}
}
}