docs: 完善参数注释与StyleCop配置

This commit is contained in:
2025-12-04 12:45:26 +08:00
parent 8e4c2b0e45
commit 37e7d721f3
213 changed files with 695 additions and 446 deletions

View File

@@ -1,6 +1,3 @@
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using TakeoutSaaS.Domain.SystemParameters.Entities;
namespace TakeoutSaaS.Domain.SystemParameters.Repositories;
@@ -13,35 +10,56 @@ public interface ISystemParameterRepository
/// <summary>
/// 根据标识获取系统参数。
/// </summary>
/// <param name="id">参数 ID。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>系统参数或 null。</returns>
Task<SystemParameter?> FindByIdAsync(long id, CancellationToken cancellationToken = default);
/// <summary>
/// 根据键获取系统参数(当前租户)。
/// </summary>
/// <param name="key">参数键。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>系统参数或 null。</returns>
Task<SystemParameter?> FindByKeyAsync(string key, CancellationToken cancellationToken = default);
/// <summary>
/// 查询系统参数列表。
/// </summary>
/// <param name="keyword">关键字。</param>
/// <param name="isEnabled">启用状态。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>参数列表。</returns>
Task<IReadOnlyList<SystemParameter>> SearchAsync(string? keyword, bool? isEnabled, CancellationToken cancellationToken = default);
/// <summary>
/// 新增系统参数。
/// </summary>
/// <param name="parameter">参数实体。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>异步任务。</returns>
Task AddAsync(SystemParameter parameter, CancellationToken cancellationToken = default);
/// <summary>
/// 删除系统参数。
/// </summary>
/// <param name="parameter">参数实体。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>异步任务。</returns>
Task RemoveAsync(SystemParameter parameter, CancellationToken cancellationToken = default);
/// <summary>
/// 更新系统参数。
/// </summary>
/// <param name="parameter">参数实体。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>异步任务。</returns>
Task UpdateAsync(SystemParameter parameter, CancellationToken cancellationToken = default);
/// <summary>
/// 持久化更改。
/// </summary>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>异步任务。</returns>
Task SaveChangesAsync(CancellationToken cancellationToken = default);
}