CJKmkp/community
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(docstring):添加部分docstring (#376)

Browse Source 
* 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
Download Patch File Download Diff File Expand all files Collapse all files
Ink Canvas/Models/CapturedImage.cs
+30 -1
View File
@@ -12,6 +12,11 @@ namespace Ink_Canvas.Models
public string Timestamp { get; }
public string FilePath { get; }
/// <summary>
/// 使用指定的位图创建一个 CapturedImage 实例，并为其生成缩略图、空白笔划集合和时间戳。
/// </summary>
/// <param name="image">用于初始化的位图；不能为空。传入的图像将在内部确保为冻结状态以便安全跨线程使用。</param>
/// <exception cref="System.ArgumentNullException">当 <paramref name="image"/> 为 null 时抛出。</exception>
public CapturedImage(BitmapImage image)
{
if (image == null)
@@ -25,6 +30,12 @@ namespace Ink_Canvas.Models
FilePath = null;
}
/// <summary>
/// 初始化 CapturedImage 实例：将指定图像冻结用于线程安全、生成缩略图并初始化空的笔迹集合，同时设置文件路径和时间戳（尝试从文件名提取时间戳，失败则使用当前时间）。
/// </summary>
/// <param name="image">源图像，不能为空。</param>
/// <param name="filePath">关联文件的路径，可能为 null。</param>
/// <exception cref="ArgumentNullException">当 <paramref name="image"/> 为 null 时抛出。</exception>
public CapturedImage(BitmapImage image, string filePath)
{
if (image == null)
@@ -38,6 +49,11 @@ namespace Ink_Canvas.Models
Timestamp = TryExtractTimestampFromFilePath(filePath) ?? DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss.fff");
}
/// <summary>
/// 尝试从给定文件路径的文件名中解析并返回规范化的时间戳。
/// </summary>
/// <param name="filePath">要从其文件名中解析时间戳的文件路径；可以为 null 或空字符串。</param>
/// <returns>解析得到的时间戳，格式为 "yyyy-MM-dd HH:mm:ss.fff"；无法解析时返回 null。</returns>
private static string TryExtractTimestampFromFilePath(string filePath)
{
try
@@ -74,6 +90,12 @@ namespace Ink_Canvas.Models
}
}
/// <summary>
/// 确保并返回一个已冻结的 BitmapImage 副本，以便在跨线程场景中安全使用。
/// </summary>
/// <param name="image">要确保为冻结状态的源 BitmapImage。</param>
/// <returns>与输入图像内容一致且已调用 Freeze 的 BitmapImage 实例。</returns>
/// <exception cref="ArgumentNullException">在 <paramref name="image"/> 为 null 时抛出。</exception>
private static BitmapImage EnsureFrozen(BitmapImage image)
{
if (image == null)
@@ -99,6 +121,14 @@ namespace Ink_Canvas.Models
return frozenCopy;
}
/// <summary>
/// 生成并返回一个在 290×180 约束内按比例缩放并已冻结的缩略图。
/// </summary>
/// <param name="original">用于生成缩略图的源 <see cref="BitmapImage"/>；不得为 <c>null</c>，且其像素宽度和高度必须大于 0。</param>
/// <returns>已冻结的 <see cref="BitmapImage"/> 缩略图，尺寸不超过 290×180 且保持原图纵横比。</returns>
/// <exception cref="ArgumentNullException">当 <paramref name="original"/> 为 <c>null</c> 时抛出。</exception>
/// <exception cref="ArgumentException">当 <paramref name="original"/> 的像素宽度或高度小于等于 0 时抛出。</exception>
/// <exception cref="InvalidOperationException">当无法计算出有效的缩放比例（例如结果为 NaN、Infinity 或非正数）时抛出。</exception>
private static BitmapImage CreateThumbnail(BitmapImage original)
{
if (original == null)
@@ -143,4 +173,3 @@ namespace Ink_Canvas.Models
}
}
}