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

src/Domain/TakeoutSaaS.Domain/Merchants/Repositories/IMerchantCategoryRepository.cs

@@ -1,6 +1,3 @@
-using System.Collections.Generic;
-using System.Threading;
-using System.Threading.Tasks;
 using TakeoutSaaS.Domain.Merchants.Entities;
 
 namespace TakeoutSaaS.Domain.Merchants.Repositories;
@@ -13,35 +10,57 @@ public interface IMerchantCategoryRepository
     /// <summary>
     /// 列出当前租户的类目。
     /// </summary>
+    /// <param name="tenantId">租户 ID。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>类目列表。</returns>
     Task<IReadOnlyList<MerchantCategory>> ListAsync(long tenantId, CancellationToken cancellationToken = default);
 
     /// <summary>
     /// 是否存在同名类目。
     /// </summary>
+    /// <param name="name">类目名称。</param>
+    /// <param name="tenantId">租户 ID。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>存在返回 true。</returns>
     Task<bool> ExistsAsync(string name, long tenantId, CancellationToken cancellationToken = default);
 
     /// <summary>
     /// 查找类目。
     /// </summary>
+    /// <param name="id">类目 ID。</param>
+    /// <param name="tenantId">租户 ID。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>类目实体或 null。</returns>
     Task<MerchantCategory?> FindByIdAsync(long id, long tenantId, CancellationToken cancellationToken = default);
 
     /// <summary>
     /// 新增类目。
     /// </summary>
+    /// <param name="category">类目实体。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>异步任务。</returns>
     Task AddAsync(MerchantCategory category, CancellationToken cancellationToken = default);
 
     /// <summary>
     /// 删除类目。
     /// </summary>
+    /// <param name="category">类目实体。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>异步任务。</returns>
     Task RemoveAsync(MerchantCategory category, CancellationToken cancellationToken = default);
 
     /// <summary>
     /// 批量更新类目信息。
     /// </summary>
+    /// <param name="categories">类目集合。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>异步任务。</returns>
     Task UpdateRangeAsync(IEnumerable<MerchantCategory> categories, CancellationToken cancellationToken = default);
 
     /// <summary>
     /// 持久化更改。
     /// </summary>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>异步任务。</returns>
     Task SaveChangesAsync(CancellationToken cancellationToken = default);
 }

src/Domain/TakeoutSaaS.Domain/Merchants/Repositories/IMerchantRepository.cs

@@ -1,6 +1,3 @@
-using System.Collections.Generic;
-using System.Threading;
-using System.Threading.Tasks;
 using TakeoutSaaS.Domain.Merchants.Entities;
 using TakeoutSaaS.Domain.Merchants.Enums;
 
@@ -14,21 +11,37 @@ public interface IMerchantRepository
     /// <summary>
     /// 依据标识获取商户。
     /// </summary>
+    /// <param name="merchantId">商户 ID。</param>
+    /// <param name="tenantId">租户 ID。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>商户实体或 null。</returns>
     Task<Merchant?> FindByIdAsync(long merchantId, long tenantId, CancellationToken cancellationToken = default);
 
     /// <summary>
     /// 按状态筛选商户列表。
     /// </summary>
+    /// <param name="tenantId">租户 ID。</param>
+    /// <param name="status">状态过滤。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>商户集合。</returns>
     Task<IReadOnlyList<Merchant>> SearchAsync(long tenantId, MerchantStatus? status, CancellationToken cancellationToken = default);
 
     /// <summary>
     /// 获取指定商户的员工列表。
     /// </summary>
+    /// <param name="merchantId">商户 ID。</param>
+    /// <param name="tenantId">租户 ID。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>员工集合。</returns>
     Task<IReadOnlyList<MerchantStaff>> GetStaffAsync(long merchantId, long tenantId, CancellationToken cancellationToken = default);
 
     /// <summary>
     /// 获取指定商户的合同列表。
     /// </summary>
+    /// <param name="merchantId">商户 ID。</param>
+    /// <param name="tenantId">租户 ID。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>合同集合。</returns>
     Task<IReadOnlyList<MerchantContract>> GetContractsAsync(long merchantId, long tenantId, CancellationToken cancellationToken = default);
 
     /// <summary>
@@ -44,6 +57,10 @@ public interface IMerchantRepository
     /// <summary>
     /// 获取指定商户的资质文件列表。
     /// </summary>
+    /// <param name="merchantId">商户 ID。</param>
+    /// <param name="tenantId">租户 ID。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>资质文件列表。</returns>
     Task<IReadOnlyList<MerchantDocument>> GetDocumentsAsync(long merchantId, long tenantId, CancellationToken cancellationToken = default);
 
     /// <summary>
@@ -59,16 +76,25 @@ public interface IMerchantRepository
     /// <summary>
     /// 新增商户主体。
     /// </summary>
+    /// <param name="merchant">商户实体。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>异步任务。</returns>
     Task AddMerchantAsync(Merchant merchant, CancellationToken cancellationToken = default);
 
     /// <summary>
     /// 新增商户员工。
     /// </summary>
+    /// <param name="staff">员工实体。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>异步任务。</returns>
     Task AddStaffAsync(MerchantStaff staff, CancellationToken cancellationToken = default);
 
     /// <summary>
     /// 新增商户合同。
     /// </summary>
+    /// <param name="contract">合同实体。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>异步任务。</returns>
     Task AddContractAsync(MerchantContract contract, CancellationToken cancellationToken = default);
 
     /// <summary>
@@ -82,6 +108,9 @@ public interface IMerchantRepository
     /// <summary>
     /// 新增商户资质文件。
     /// </summary>
+    /// <param name="document">资质文件实体。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>异步任务。</returns>
     Task AddDocumentAsync(MerchantDocument document, CancellationToken cancellationToken = default);
 
     /// <summary>
@@ -95,25 +124,41 @@ public interface IMerchantRepository
     /// <summary>
     /// 持久化变更。
     /// </summary>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>异步任务。</returns>
     Task SaveChangesAsync(CancellationToken cancellationToken = default);
 
     /// <summary>
     /// 更新商户信息。
     /// </summary>
+    /// <param name="merchant">商户实体。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>异步任务。</returns>
     Task UpdateMerchantAsync(Merchant merchant, CancellationToken cancellationToken = default);
 
     /// <summary>
     /// 删除商户。
     /// </summary>
+    /// <param name="merchantId">商户 ID。</param>
+    /// <param name="tenantId">租户 ID。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>异步任务。</returns>
     Task DeleteMerchantAsync(long merchantId, long tenantId, CancellationToken cancellationToken = default);
 
     /// <summary>
     /// 记录审核日志。
     /// </summary>
+    /// <param name="log">审核日志实体。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>异步任务。</returns>
     Task AddAuditLogAsync(MerchantAuditLog log, CancellationToken cancellationToken = default);
 
     /// <summary>
     /// 获取审核日志。
     /// </summary>
+    /// <param name="merchantId">商户 ID。</param>
+    /// <param name="tenantId">租户 ID。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>审核日志列表。</returns>
     Task<IReadOnlyList<MerchantAuditLog>> GetAuditLogsAsync(long merchantId, long tenantId, CancellationToken cancellationToken = default);
 }