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
@@ -38,6 +38,18 @@ namespace Ink_Canvas
}
public partial class MainWindow : Window
{
/// <summary>
/// 保存墨迹的鼠标释放事件处理
/// </summary>
/// <param name="sender">发送者</param>
/// <param name="e">鼠标按钮事件参数</param>
/// <remarks>
/// 该方法会:
/// 1. 检查是否是当前按下的对象,且墨迹画布是否可见
/// 2. 隐藏工具面板
/// 3. 隐藏通知面板
/// 4. 调用SaveInkCanvasStrokes方法保存墨迹
/// </remarks>
private void SymbolIconSaveStrokes_MouseUp(object sender, MouseButtonEventArgs e)
{
if (lastBorderMouseDownObject != sender || inkCanvas.Visibility != Visibility.Visible) return;
@@ -50,6 +62,23 @@ namespace Ink_Canvas
SaveInkCanvasStrokes(true, true);
}
/// <summary>
/// 保存墨迹画布的墨迹
/// </summary>
/// <param name="newNotice">是否显示新的通知</param>
/// <param name="saveByUser">是否是用户手动保存</param>
/// <remarks>
/// 该方法会:
/// 1. 根据保存类型和模式确定保存路径
/// 2. 创建保存目录
/// 3. 根据当前模式生成保存文件名
/// 4. 根据设置选择保存模式:
/// - 全页面保存模式:保存为图像或压缩包
/// - XML保存模式:保存为XML文件或压缩包
/// - 常规保存模式:保存为二进制格式或XML格式
/// 5. 异步上传保存的文件到Dlass
/// 6. 保存元素信息
/// </remarks>
private void SaveInkCanvasStrokes(bool newNotice = true, bool saveByUser = false)
{
try
@@ -673,6 +702,22 @@ namespace Ink_Canvas
}
}
/// <summary>
/// 打开墨迹文件的鼠标释放事件处理
/// </summary>
/// <param name="sender">发送者</param>
/// <param name="e">鼠标按钮事件参数</param>
/// <remarks>
/// 该方法会:
/// 1. 检查是否是当前按下的对象
/// 2. 隐藏工具面板
/// 3. 打开文件选择对话框
/// 4. 根据文件扩展名选择不同的打开方式:
/// - .zip:处理ICC压缩包
/// - .xml:处理XML格式墨迹文件
/// - 其他:处理单个墨迹文件(二进制格式)
/// 5. 如果墨迹画布不可见,切换到鼠标模式
/// </remarks>
private void SymbolIconOpenStrokes_MouseUp(object sender, MouseButtonEventArgs e)
{
if (lastBorderMouseDownObject != sender) return;
@@ -1157,6 +1202,15 @@ namespace Ink_Canvas
/// <summary>
/// 打开单个墨迹文件
/// </summary>
/// <param name="filePath">墨迹文件的路径</param>
/// <remarks>
/// 该方法会:
/// 1. 打开墨迹文件并加载墨迹
/// 2. 检查文件是否包含墨迹
/// 3. 如果包含墨迹,清空当前墨迹并添加新墨迹
/// 4. 恢复元素信息
/// 5. 如果文件流中没有墨迹,尝试从内存流中加载
/// </remarks>
public void OpenSingleStrokeFile(string filePath)
{
var fileStreamHasNoStroke = false;