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.Stores.Entities;
using TakeoutSaaS.Domain.Stores.Enums;
@@ -14,90 +11,152 @@ public interface IStoreRepository
/// <summary>
/// 依据标识获取门店。
/// </summary>
/// <param name="storeId">门店 ID。</param>
/// <param name="tenantId">租户 ID。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>门店实体或 null。</returns>
Task<Store?> FindByIdAsync(long storeId, long tenantId, CancellationToken cancellationToken = default);
/// <summary>
/// 按租户筛选门店列表。
/// </summary>
/// <param name="tenantId">租户 ID。</param>
/// <param name="status">状态过滤。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>门店集合。</returns>
Task<IReadOnlyList<Store>> SearchAsync(long tenantId, StoreStatus? status, CancellationToken cancellationToken = default);
/// <summary>
/// 获取门店营业时段。
/// </summary>
/// <param name="storeId">门店 ID。</param>
/// <param name="tenantId">租户 ID。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>营业时段列表。</returns>
Task<IReadOnlyList<StoreBusinessHour>> GetBusinessHoursAsync(long storeId, long tenantId, CancellationToken cancellationToken = default);
/// <summary>
/// 获取门店配送区域配置。
/// </summary>
/// <param name="storeId">门店 ID。</param>
/// <param name="tenantId">租户 ID。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>配送区域列表。</returns>
Task<IReadOnlyList<StoreDeliveryZone>> GetDeliveryZonesAsync(long storeId, long tenantId, CancellationToken cancellationToken = default);
/// <summary>
/// 获取门店节假日配置。
/// </summary>
/// <param name="storeId">门店 ID。</param>
/// <param name="tenantId">租户 ID。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>节假日配置列表。</returns>
Task<IReadOnlyList<StoreHoliday>> GetHolidaysAsync(long storeId, long tenantId, CancellationToken cancellationToken = default);
/// <summary>
/// 获取门店桌台区域。
/// </summary>
/// <param name="storeId">门店 ID。</param>
/// <param name="tenantId">租户 ID。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>桌台区域列表。</returns>
Task<IReadOnlyList<StoreTableArea>> GetTableAreasAsync(long storeId, long tenantId, CancellationToken cancellationToken = default);
/// <summary>
/// 获取门店桌台列表。
/// </summary>
/// <param name="storeId">门店 ID。</param>
/// <param name="tenantId">租户 ID。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>桌台列表。</returns>
Task<IReadOnlyList<StoreTable>> GetTablesAsync(long storeId, long tenantId, CancellationToken cancellationToken = default);
/// <summary>
/// 获取门店员工排班。
/// </summary>
/// <param name="storeId">门店 ID。</param>
/// <param name="tenantId">租户 ID。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>排班列表。</returns>
Task<IReadOnlyList<StoreEmployeeShift>> GetShiftsAsync(long storeId, long tenantId, CancellationToken cancellationToken = default);
/// <summary>
/// 新增门店。
/// </summary>
/// <param name="store">门店实体。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>异步任务。</returns>
Task AddStoreAsync(Store store, CancellationToken cancellationToken = default);
/// <summary>
/// 新增营业时段。
/// </summary>
/// <param name="hours">营业时段集合。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>异步任务。</returns>
Task AddBusinessHoursAsync(IEnumerable<StoreBusinessHour> hours, CancellationToken cancellationToken = default);
/// <summary>
/// 新增配送区域。
/// </summary>
/// <param name="zones">配送区域集合。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>异步任务。</returns>
Task AddDeliveryZonesAsync(IEnumerable<StoreDeliveryZone> zones, CancellationToken cancellationToken = default);
/// <summary>
/// 新增节假日配置。
/// </summary>
/// <param name="holidays">节假日集合。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>异步任务。</returns>
Task AddHolidaysAsync(IEnumerable<StoreHoliday> holidays, CancellationToken cancellationToken = default);
/// <summary>
/// 新增桌台区域。
/// </summary>
/// <param name="areas">桌台区域集合。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>异步任务。</returns>
Task AddTableAreasAsync(IEnumerable<StoreTableArea> areas, CancellationToken cancellationToken = default);
/// <summary>
/// 新增桌台。
/// </summary>
/// <param name="tables">桌台集合。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>异步任务。</returns>
Task AddTablesAsync(IEnumerable<StoreTable> tables, CancellationToken cancellationToken = default);
/// <summary>
/// 新增排班。
/// </summary>
/// <param name="shifts">排班集合。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>异步任务。</returns>
Task AddShiftsAsync(IEnumerable<StoreEmployeeShift> shifts, CancellationToken cancellationToken = default);
/// <summary>
/// 持久化变更。
/// </summary>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>异步任务。</returns>
Task SaveChangesAsync(CancellationToken cancellationToken = default);
/// <summary>
/// 更新门店。
/// </summary>
/// <param name="store">门店实体。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>异步任务。</returns>
Task UpdateStoreAsync(Store store, CancellationToken cancellationToken = default);
/// <summary>
/// 删除门店。
/// </summary>
/// <param name="storeId">门店 ID。</param>
/// <param name="tenantId">租户 ID。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>异步任务。</returns>
Task DeleteStoreAsync(long storeId, long tenantId, CancellationToken cancellationToken = default);
}