chore: 优化代码注释

This commit is contained in:
2025-11-23 09:52:54 +08:00
parent 1169e1f220
commit ccadacaa9d
33 changed files with 457 additions and 221 deletions

View File

@@ -1,11 +1,18 @@
namespace TakeoutSaaS.Shared.Abstractions.Entities;
/// <summary>
/// 审计字段接口
/// 审计字段接口:提供创建时间和更新时间字段。
/// </summary>
public interface IAuditableEntity
{
/// <summary>
/// 创建时间UTC
/// </summary>
DateTime CreatedAt { get; set; }
/// <summary>
/// 更新时间UTC未更新时为 null。
/// </summary>
DateTime? UpdatedAt { get; set; }
}

View File

@@ -1,5 +1,3 @@
using System;
namespace TakeoutSaaS.Shared.Abstractions.Exceptions;
/// <summary>

View File

@@ -1,4 +1,3 @@
using System;
using System.Diagnostics;
using TakeoutSaaS.Shared.Abstractions.Diagnostics;
@@ -8,7 +7,7 @@ namespace TakeoutSaaS.Shared.Abstractions.Results;
/// 统一的 API 返回结果包装。
/// </summary>
/// <typeparam name="T">数据载荷类型</typeparam>
public sealed record class ApiResponse<T>
public sealed record ApiResponse<T>
{
/// <summary>
/// 是否成功。
@@ -97,7 +96,7 @@ public sealed record class ApiResponse<T>
{
if (!string.IsNullOrWhiteSpace(TraceContext.TraceId))
{
return TraceContext.TraceId!;
return TraceContext.TraceId;
}
return Activity.Current?.Id ?? Guid.NewGuid().ToString("N");

View File

@@ -1,7 +1,14 @@
namespace TakeoutSaaS.Shared.Abstractions.Tenancy;
/// <summary>
/// 租户提供者接口:用于获取当前请求的租户标识。
/// </summary>
public interface ITenantProvider
{
/// <summary>
/// 获取当前请求的租户 ID。
/// </summary>
/// <returns>租户 ID如果未设置则返回 Guid.Empty</returns>
Guid GetCurrentTenantId();
}