docs(feedback): 添加反馈窗口和页面的XML文档注释

为反馈窗口及其三个页面添加详细的XML文档注释,说明功能、收集的信息和操作流程

Signed-off-by: doudou0720 <98651603+doudou0720@users.noreply.github.com>
This commit is contained in:
doudou0720
2026-04-05 13:17:38 +08:00
parent ae6268e8e3
commit 0d4938971b
4 changed files with 185 additions and 0 deletions
@@ -3,6 +3,17 @@ using System.Windows.Controls;
namespace Ink_Canvas.Windows.FeedbackPages
{
/// <summary>
/// 反馈页面1:环境信息选择页面。
/// 允许用户选择要包含在反馈中的系统环境信息。
/// </summary>
/// <remarks>
/// 用户可以选择包含以下信息:
/// - 软件版本和更新通道
/// - 操作系统版本、.NET版本和触控支持
/// - 设备ID和遥测ID
/// - PPT联动设置和墨迹识别设置
/// </remarks>
public partial class FeedbackPage1 : UserControl
{
public FeedbackPage1()
@@ -3,6 +3,17 @@ using System.Windows.Controls;
namespace Ink_Canvas.Windows.FeedbackPages
{
/// <summary>
/// 反馈页面2:环境信息预览页面。
/// 展示用户选择要包含在反馈中的系统环境信息。
/// </summary>
/// <remarks>
/// 显示以下信息:
/// - 软件版本信息
/// - 系统信息(操作系统、.NET版本、触控支持)
/// - 设备信息(设备ID、遥测ID)
/// - 软件配置信息(PPT联动设置、墨迹识别设置)
/// </remarks>
public partial class FeedbackPage2 : UserControl
{
public FeedbackPage2()
@@ -4,6 +4,17 @@ using System.Windows.Controls;
namespace Ink_Canvas.Windows.FeedbackPages
{
/// <summary>
/// 反馈页面3:反馈提交页面。
/// 提供Markdown模板并允许用户复制或直接打开GitHub Issue页面。
/// </summary>
/// <remarks>
/// 页面提供以下功能:
/// - 显示生成的Markdown格式环境信息模板
/// - 复制Markdown模板到剪贴板
/// - 复制预填的GitHub Issue URL到剪贴板
/// - 直接在浏览器中打开GitHub Issue创建页面
/// </remarks>
public partial class FeedbackPage3 : UserControl
{
public event EventHandler<RoutedEventArgs> BtnOpenGitHubIssueClick;