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
+41
View File
@@ -195,6 +195,12 @@ namespace Ink_Canvas.Helpers
OnSlideShowStateCheckTimerElapsed(sender, e);
}
/// <summary>
/// 启动内部轮询计时器以开始监测 ROT/PPT 连接状态和幻灯片放映状态。
/// </summary>
/// <remarks>
/// 如果实例已被释放(Dispose 已调用)或计时器未初始化,则此方法不会执行任何操作。
/// </remarks>
public void StartMonitoring()
{
if (_disposed) return;
@@ -202,12 +208,18 @@ namespace Ink_Canvas.Helpers
_unifiedRotTimer?.Start();
}
/// <summary>
/// 停止内部的 ROT 监视计时器并断开与当前 PowerPoint 实例的连接。
/// </summary>
public void StopMonitoring()
{
_unifiedRotTimer?.Stop();
DisconnectFromPPT(restartMonitoring: false);
}
/// <summary>
/// 强制断开当前与 PowerPoint 的 ROT 连接并触发后续的重连流程。
/// </summary>
public void ReloadConnection()
{
if (_disposed) return;
@@ -217,6 +229,12 @@ namespace Ink_Canvas.Helpers
#endregion
#region Connection Management
/// <summary>
/// 在计时器触发时检查与 PowerPoint 的 ROT 连接,并在尚未处于已释放或模块卸载期间时尝试通过 ROT 建立连接。
/// </summary>
/// <remarks>
/// 如果在检查或连接过程中发生异常,异常信息会记录到日志并被吞掉,不会向上抛出。
/// </remarks>
private void OnConnectionCheckTimerElapsed(object sender, ElapsedEventArgs e)
{
try
@@ -231,6 +249,12 @@ namespace Ink_Canvas.Helpers
}
}
/// <summary>
/// 在定时器触发时检查并在必要时更新 PPT 的放映状态。
/// </summary>
/// <remarks>
/// 当实例未被释放、模块未在卸载过程中且与 PowerPoint 仍保持连接时会调用内部的放映状态检查逻辑。若检查过程中发生异常,会将错误写入日志并吞并异常以保证定时器循环继续运行。
/// </remarks>
private void OnSlideShowStateCheckTimerElapsed(object sender, ElapsedEventArgs e)
{
try
@@ -245,6 +269,16 @@ namespace Ink_Canvas.Helpers
}
}
/// <summary>
/// 使用 ROT 检查并在必要时建立、切换或断开与 PowerPoint 的 COM 连接。
/// </summary>
/// <remarks>
/// 当管理器已释放或模块正在卸载时不执行任何操作。此方法在内部加锁以防止并发切换;会通过 ROT 获取当前可用的 PowerPoint 实例并:
/// - 若尚未连接则建立连接;
/// - 若当前无可用实例则断开现有连接;
/// - 若检测到已连接的实例发生变化则先断开再重新连接。
/// 遇到异常时会记录错误日志,并在存在活动连接时尝试断开以保证状态一致性。
/// </remarks>
private void CheckAndConnectToPPTViaRot()
{
if (_disposed || _isModuleUnloading) return;
@@ -318,6 +352,13 @@ namespace Ink_Canvas.Helpers
}
}
/// <summary>
/// 将指定的 PowerPoint COM 应用对象作为当前连接并在 UI 线程上注册必要的演示文稿与幻灯片放映事件,触发连接通知并在已处于放映时尝试触发一次放映开始回调。
/// </summary>
/// <param name="appObj">要绑定的 PowerPoint COM 应用对象(通常来自 ROT)。</param>
/// <remarks>
/// 如果事件注册或后续处理失败,会记录错误并在异常路径上清除内部引用(将内部应用对象置空)。方法会触发 <c>PPTConnectionChanged(true)</c> 并记录连接成功的事件日志;若检测到当前正处于幻灯片放映,则尝试调用一次放映开始的内部处理以同步状态。异常信息会写入日志,但方法不会向外抛出未捕获的异常(内部会捕获并记录错误后清理状态)。
/// </remarks>
private void ConnectToPPT(object appObj)
{
try