chore: add documentation comments and stylecop rules

src/Domain/TakeoutSaaS.Domain/Identity/Repositories/IPermissionRepository.cs

@@ -10,13 +10,80 @@ namespace TakeoutSaaS.Domain.Identity.Repositories;
 /// </summary>
 public interface IPermissionRepository
 {
+    /// <summary>
+    /// 根据 ID 查询权限。
+    /// </summary>
+    /// <param name="permissionId">权限 ID。</param>
+    /// <param name="tenantId">租户 ID。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>权限实体或 null。</returns>
     Task<Permission?> FindByIdAsync(long permissionId, long tenantId, CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// 根据编码查询权限。
+    /// </summary>
+    /// <param name="code">权限编码。</param>
+    /// <param name="tenantId">租户 ID。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>权限实体或 null。</returns>
     Task<Permission?> FindByCodeAsync(string code, long tenantId, CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// 根据编码集合查询权限列表。
+    /// </summary>
+    /// <param name="tenantId">租户 ID。</param>
+    /// <param name="codes">权限编码集合。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>权限集合。</returns>
     Task<IReadOnlyList<Permission>> GetByCodesAsync(long tenantId, IEnumerable<string> codes, CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// 根据 ID 集合查询权限列表。
+    /// </summary>
+    /// <param name="tenantId">租户 ID。</param>
+    /// <param name="permissionIds">权限 ID 集合。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>权限集合。</returns>
     Task<IReadOnlyList<Permission>> GetByIdsAsync(long tenantId, IEnumerable<long> permissionIds, CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// 按关键字搜索权限。
+    /// </summary>
+    /// <param name="tenantId">租户 ID。</param>
+    /// <param name="keyword">关键字。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>权限集合。</returns>
     Task<IReadOnlyList<Permission>> SearchAsync(long tenantId, string? keyword, CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// 新增权限。
+    /// </summary>
+    /// <param name="permission">权限实体。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>异步操作任务。</returns>
     Task AddAsync(Permission permission, CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// 更新权限。
+    /// </summary>
+    /// <param name="permission">权限实体。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>异步操作任务。</returns>
     Task UpdateAsync(Permission permission, CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// 删除权限。
+    /// </summary>
+    /// <param name="permissionId">权限 ID。</param>
+    /// <param name="tenantId">租户 ID。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>异步操作任务。</returns>
     Task DeleteAsync(long permissionId, long tenantId, CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// 保存仓储变更。
+    /// </summary>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>异步操作任务。</returns>
     Task SaveChangesAsync(CancellationToken cancellationToken = default);
 }

src/Domain/TakeoutSaaS.Domain/Identity/Repositories/IRolePermissionRepository.cs

@@ -10,8 +10,37 @@ namespace TakeoutSaaS.Domain.Identity.Repositories;
 /// </summary>
 public interface IRolePermissionRepository
 {
+    /// <summary>
+    /// 根据角色 ID 集合获取角色权限关系。
+    /// </summary>
+    /// <param name="tenantId">租户 ID。</param>
+    /// <param name="roleIds">角色 ID 集合。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>角色权限关系列表。</returns>
     Task<IReadOnlyList<RolePermission>> GetByRoleIdsAsync(long tenantId, IEnumerable<long> roleIds, CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// 批量新增角色权限关系。
+    /// </summary>
+    /// <param name="rolePermissions">角色权限集合。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>异步操作任务。</returns>
     Task AddRangeAsync(IEnumerable<RolePermission> rolePermissions, CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// 替换角色的权限集合。
+    /// </summary>
+    /// <param name="tenantId">租户 ID。</param>
+    /// <param name="roleId">角色 ID。</param>
+    /// <param name="permissionIds">权限 ID 集合。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>异步操作任务。</returns>
     Task ReplaceRolePermissionsAsync(long tenantId, long roleId, IEnumerable<long> permissionIds, CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// 提交持久化变更。
+    /// </summary>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>异步操作任务。</returns>
     Task SaveChangesAsync(CancellationToken cancellationToken = default);
 }

src/Domain/TakeoutSaaS.Domain/Identity/Repositories/IRoleRepository.cs

@@ -10,12 +10,71 @@ namespace TakeoutSaaS.Domain.Identity.Repositories;
 /// </summary>
 public interface IRoleRepository
 {
+    /// <summary>
+    /// 根据 ID 查询角色。
+    /// </summary>
+    /// <param name="roleId">角色 ID。</param>
+    /// <param name="tenantId">租户 ID。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>角色实体或 null。</returns>
     Task<Role?> FindByIdAsync(long roleId, long tenantId, CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// 根据编码查询角色。
+    /// </summary>
+    /// <param name="code">角色编码。</param>
+    /// <param name="tenantId">租户 ID。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>角色实体或 null。</returns>
     Task<Role?> FindByCodeAsync(string code, long tenantId, CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// 批量获取角色列表。
+    /// </summary>
+    /// <param name="tenantId">租户 ID。</param>
+    /// <param name="roleIds">角色 ID 集合。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>角色集合。</returns>
     Task<IReadOnlyList<Role>> GetByIdsAsync(long tenantId, IEnumerable<long> roleIds, CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// 按关键字搜索角色。
+    /// </summary>
+    /// <param name="tenantId">租户 ID。</param>
+    /// <param name="keyword">关键字。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>角色集合。</returns>
     Task<IReadOnlyList<Role>> SearchAsync(long tenantId, string? keyword, CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// 新增角色。
+    /// </summary>
+    /// <param name="role">角色实体。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>异步操作任务。</returns>
     Task AddAsync(Role role, CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// 更新角色。
+    /// </summary>
+    /// <param name="role">角色实体。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>异步操作任务。</returns>
     Task UpdateAsync(Role role, CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// 删除角色。
+    /// </summary>
+    /// <param name="roleId">角色 ID。</param>
+    /// <param name="tenantId">租户 ID。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>异步操作任务。</returns>
     Task DeleteAsync(long roleId, long tenantId, CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// 保存仓储变更。
+    /// </summary>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>异步操作任务。</returns>
     Task SaveChangesAsync(CancellationToken cancellationToken = default);
 }

src/Domain/TakeoutSaaS.Domain/Identity/Repositories/IRoleTemplateRepository.cs

@@ -10,19 +10,68 @@ namespace TakeoutSaaS.Domain.Identity.Repositories;
 /// </summary>
 public interface IRoleTemplateRepository
 {
+    /// <summary>
+    /// 查询角色模板列表。
+    /// </summary>
+    /// <param name="isActive">启用状态过滤。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>角色模板集合。</returns>
     Task<IReadOnlyList<RoleTemplate>> GetAllAsync(bool? isActive, CancellationToken cancellationToken = default);
 
+    /// <summary>
+    /// 通过模板编码获取模板信息。
+    /// </summary>
+    /// <param name="templateCode">模板编码。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>模板实体或 null。</returns>
     Task<RoleTemplate?> FindByCodeAsync(string templateCode, CancellationToken cancellationToken = default);
 
+    /// <summary>
+    /// 获取模板的权限列表。
+    /// </summary>
+    /// <param name="roleTemplateId">模板 ID。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>权限集合。</returns>
     Task<IReadOnlyList<RoleTemplatePermission>> GetPermissionsAsync(long roleTemplateId, CancellationToken cancellationToken = default);
 
+    /// <summary>
+    /// 批量获取多个模板的权限映射。
+    /// </summary>
+    /// <param name="roleTemplateIds">模板 ID 集合。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>模板与权限列表的映射。</returns>
     Task<IDictionary<long, IReadOnlyList<RoleTemplatePermission>>> GetPermissionsAsync(IEnumerable<long> roleTemplateIds, CancellationToken cancellationToken = default);
 
+    /// <summary>
+    /// 新增模板及其权限。
+    /// </summary>
+    /// <param name="template">模板实体。</param>
+    /// <param name="permissionCodes">权限编码集合。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>异步操作任务。</returns>
     Task AddAsync(RoleTemplate template, IEnumerable<string> permissionCodes, CancellationToken cancellationToken = default);
 
+    /// <summary>
+    /// 更新模板及权限。
+    /// </summary>
+    /// <param name="template">模板实体。</param>
+    /// <param name="permissionCodes">权限编码集合。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>异步操作任务。</returns>
     Task UpdateAsync(RoleTemplate template, IEnumerable<string> permissionCodes, CancellationToken cancellationToken = default);
 
+    /// <summary>
+    /// 删除模板。
+    /// </summary>
+    /// <param name="roleTemplateId">模板 ID。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>异步操作任务。</returns>
     Task DeleteAsync(long roleTemplateId, CancellationToken cancellationToken = default);
 
+    /// <summary>
+    /// 保存仓储变更。
+    /// </summary>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>异步操作任务。</returns>
     Task SaveChangesAsync(CancellationToken cancellationToken = default);
 }

src/Domain/TakeoutSaaS.Domain/Identity/Repositories/IUserRoleRepository.cs

@@ -10,8 +10,38 @@ namespace TakeoutSaaS.Domain.Identity.Repositories;
 /// </summary>
 public interface IUserRoleRepository
 {
+    /// <summary>
+    /// 批量获取指定用户的角色关系。
+    /// </summary>
+    /// <param name="tenantId">租户 ID。</param>
+    /// <param name="userIds">用户 ID 集合。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>用户角色关系集合。</returns>
     Task<IReadOnlyList<UserRole>> GetByUserIdsAsync(long tenantId, IEnumerable<long> userIds, CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// 获取单个用户的角色关系。
+    /// </summary>
+    /// <param name="tenantId">租户 ID。</param>
+    /// <param name="userId">用户 ID。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>指定用户的角色关系列表。</returns>
     Task<IReadOnlyList<UserRole>> GetByUserIdAsync(long tenantId, long userId, CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// 替换用户的角色列表。
+    /// </summary>
+    /// <param name="tenantId">租户 ID。</param>
+    /// <param name="userId">用户 ID。</param>
+    /// <param name="roleIds">角色 ID 集合。</param>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>异步操作任务。</returns>
     Task ReplaceUserRolesAsync(long tenantId, long userId, IEnumerable<long> roleIds, CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// 提交持久化变更。
+    /// </summary>
+    /// <param name="cancellationToken">取消标记。</param>
+    /// <returns>异步操作任务。</returns>
     Task SaveChangesAsync(CancellationToken cancellationToken = default);
 }