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
+34 -2
View File
@@ -665,6 +665,18 @@ namespace Ink_Canvas
private TaskbarIcon _taskbar;
/// <summary>
/// 处理应用启动流程:根据命令行与设置显示启动画面、初始化组件与遥测、处理更新相关逻辑、单实例检查并在必要时通过 IPC 与已运行实例通信,最终创建并显示主窗口并启动文件关联与 IPC 监听器。
/// </summary>
/// <param name="sender">事件的发送者(通常为 Application 对象)。</param>
/// <param name="e">启动事件参数;其 Args 可包含控制启动流程的标志,例如:
/// - "--final-app":表示这是更新后的最终应用启动(会清理更新标记等)
/// - "--update-mode":表示以更新模式启动(跳过主窗口显示)
/// - "--board":直接进入白板模式
/// - "--show":退出收纳模式并恢复浮动栏
/// - "--skip-mutex-check":跳过单实例互斥检查
/// - "-m":允许多实例启动
/// 另外也可能包含以 "icc:" 开头的 URI 参数或 .icstk 文件路径用于启动时的 IPC 交互。</param>
async void App_Startup(object sender, StartupEventArgs e)
{
appStartTime = DateTime.Now;
@@ -1159,6 +1171,17 @@ namespace Ink_Canvas
private static DateTime splashScreenStartTime = DateTime.MinValue;
private static DateTime appStartupStartTime = DateTime.MinValue;
/// <summary>
/// 启动并管理应用的心跳与守护检查定时器,监测启动阶段与主线程是否无响应,并在符合配置的情况下尝试静默重启应用。
/// </summary>
/// <remarks>
/// - 启动一个每秒更新心跳时间戳的调度定时器和一个每3秒运行的守护定时器。
/// - 守护定时器在首次运行的启动阶段若检测到超过两分钟未完成启动,会根据 CrashAction 配置尝试静默重启。
/// - 在启动完成后若检测到主线程超过10秒无响应,会根据 CrashAction 配置尝试静默重启。
/// - 对连续重启次数有保护:若重启计数达到或超过5次,会弹出提示并停止自动重启(重置重启计数并退出进程)。
/// - 在 OOBE(首次引导)展示期间不执行守护检查。
/// - 该方法会产生外部可观察的副作用:可能启动新进程并调用 Environment.Exit 终止当前进程,或显示消息框。
/// </remarks>
private void StartHeartbeatMonitor()
{
heartbeatTimer = new DispatcherTimer
@@ -1248,7 +1271,16 @@ namespace Ink_Canvas
watchdogProcess = Process.Start(psi);
}
// 看门狗主逻辑
/// <summary>
/// 作为守护进程监视指定的主进程,并在主进程异常退出时根据配置执行重启或退出操作。
/// </summary>
/// <remarks>
/// 该方法期望命令行参数格式为:"--watchdog &lt;pid&gt; &lt;exitSignalFile&gt;"args[1..3])。
/// - 每 2 秒检查一次指定的主进程是否仍在运行;同时检测退出信号文件,若存在则删除该文件并以代码 0 退出守护进程。
/// - 当主进程退出时,会同步崩溃处理设置(SyncCrashActionFromSettings)。若启用了 UIA 顶层访问(IsUIAccessTopMostEnabled),守护进程直接退出。
/// - 若崩溃动作为 SilentRestart,则增加启动计数并:当连续重启计数达到 5 次及以上时弹出错误对话框、重置计数并以代码 1 退出;否则启动新的主进程实例。
/// 方法对内部异常静默处理,并在完成后确保进程退出。
/// </remarks>
public static void RunWatchdogIfNeeded()
{
var args = Environment.GetCommandLineArgs();
@@ -1405,4 +1437,4 @@ namespace Ink_Canvas
}
}
}
}
}