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
+37 -1
View File
@@ -21,6 +21,11 @@ namespace Ink_Canvas
{
public partial class MainWindow : Window
{
/// <summary>
/// 从配置文件加载用户设置并将其应用到主窗口和相关控件的状态(包括启动、外观、画布、手势、PPT、自动化等各项配置)。
/// </summary>
/// <param name="isStartup">指示当前为应用启动阶段;为 true 时按启动流程应用启动相关设置(例如触发启动专用动作和启动时的行为)。</param>
/// <param name="skipAutoUpdateCheck">指示是否跳过自动更新检查;为 true 时不会在加载设置后执行自动更新检测。</param>
private void LoadSettings(bool isStartup = false, bool skipAutoUpdateCheck = false)
{
AppVersionTextBlock.Text = Assembly.GetExecutingAssembly().GetName().Version.ToString();
@@ -1241,6 +1246,12 @@ namespace Ink_Canvas
LoadBrushAutoRestoreSettings();
}
/// <summary>
/// 将画笔自动恢复相关的设置应用到界面控件并在启用时初始化自动恢复定时器。
/// </summary>
/// <remarks>
/// 会将 Settings.Canvas 中的 BrushAutoRestore 配置同步到对应的切换开关、时间文本框、颜色下拉框、宽度和透明度滑块;当颜色缺失时会使用默认值 `#FFFF0000`,当宽度无效时使用默认值 `5`。若功能被启用,会初始化并启动定时器以执行自动恢复任务。方法执行过程中会记录加载结果或错误信息到日志。
/// </remarks>
private void LoadBrushAutoRestoreSettings()
{
try
@@ -1385,7 +1396,18 @@ namespace Ink_Canvas
}
}
/// <summary>
/// 清理配置文件中的过期设置
/// </summary>
/// <param name="userConfigJson">用户配置的JSON字符串</param>
/// <remarks>
/// 清理过期设置时:
/// 1. 创建默认配置对象
/// 2. 将默认配置和用户配置都序列化为JObject
/// 3. 递归比较并删除用户配置中多余的键
/// 4. 如果有清理操作,重新反序列化并保存
/// 5. 记录清理结果到日志
/// </remarks>
private void CleanupObsoleteSettings(string userConfigJson)
{
try
@@ -1418,9 +1440,23 @@ namespace Ink_Canvas
}
}
/// <summary>
/// 递归删除用户配置中多余的属性
/// </summary>
/// <param name="userObj">用户配置的JObject</param>
/// <param name="defaultObj">默认配置的JObject</param>
/// <param name="hasChanges">是否有变更的引用标志</param>
/// <remarks>
/// 递归删除多余属性时:
/// 1. 检查用户配置和默认配置是否为空
/// 2. 获取需要删除的键列表
/// 3. 遍历用户配置的所有属性
/// 4. 如果默认配置中不存在该属性,标记为删除
/// 5. 如果两个属性都是对象类型,递归比较
/// 6. 处理数组中的对象(如自定义图标列表等)
/// 7. 删除标记的键
/// 8. 设置变更标志
/// </remarks>
private void RemoveObsoleteProperties(JObject userObj, JObject defaultObj, ref bool hasChanges)
{
if (userObj == null || defaultObj == null)
@@ -1482,4 +1518,4 @@ namespace Ink_Canvas
}
}
}
}
}