补充注释

SimpleAdmin.Application/Services/Onboarding/ContractTemplate/OnboardingContractTemplateService.cs

@@ -5,6 +5,9 @@ namespace SimpleAdmin.Application;
 /// </summary>
 public class OnboardingContractTemplateService : DbRepository<ObContractTemplate>, IOnboardingContractTemplateService
 {
+    /// <summary>
+    /// 分页查询合同模板主档案。
+    /// </summary>
     public async Task<SqlSugarPagedList<ObContractTemplate>> Page(OnboardingContractTemplatePageInput input)
     {
         return await Context.Queryable<ObContractTemplate>()
@@ -18,17 +21,26 @@ public class OnboardingContractTemplateService : DbRepository<ObContractTemplate
             .ToPagedListAsync(input.PageNum, input.PageSize);
     }
 
+    /// <summary>
+    /// 查询合同模板详情。
+    /// </summary>
     public async Task<ObContractTemplate> Detail(BaseIdInput input)
     {
         return await GetByIdAsync(input.Id) ?? throw Oops.Bah("合同模板不存在");
     }
 
+    /// <summary>
+    /// 新增合同模板主档案。
+    /// </summary>
     public async Task Add(OnboardingContractTemplateAddInput input)
     {
         await EnsureCodeUnique(input.TemplateCode, 0);
         await InsertAsync(input.Adapt<ObContractTemplate>());
     }
 
+    /// <summary>
+    /// 编辑合同模板主档案。
+    /// </summary>
     public async Task Edit(OnboardingContractTemplateEditInput input)
     {
         await Detail(new BaseIdInput { Id = input.Id });
@@ -36,6 +48,9 @@ public class OnboardingContractTemplateService : DbRepository<ObContractTemplate
         await UpdateAsync(input.Adapt<ObContractTemplate>());
     }
 
+    /// <summary>
+    /// 删除未被版本、适用范围或任务合同引用的模板。
+    /// </summary>
     public async Task Delete(BaseIdListInput input)
     {
         if (input.Ids.Count == 0)
@@ -59,6 +74,9 @@ public class OnboardingContractTemplateService : DbRepository<ObContractTemplate
         await DeleteByIdsAsync(input.Ids.Cast<object>().ToArray());
     }
 
+    /// <summary>
+    /// 分页查询指定合同模板的版本。
+    /// </summary>
     public async Task<SqlSugarPagedList<ObContractTemplateVersion>> VersionPage(OnboardingContractVersionPageInput input)
     {
         return await Context.Queryable<ObContractTemplateVersion>()
@@ -68,6 +86,9 @@ public class OnboardingContractTemplateService : DbRepository<ObContractTemplate
             .ToPagedListAsync(input.PageNum, input.PageSize);
     }
 
+    /// <summary>
+    /// 新增合同模板 DOCX 版本。
+    /// </summary>
     public async Task AddVersion(OnboardingContractVersionAddInput input)
     {
         await Detail(new BaseIdInput { Id = input.TemplateId });
@@ -85,6 +106,9 @@ public class OnboardingContractTemplateService : DbRepository<ObContractTemplate
         await Context.Insertable(input.Adapt<ObContractTemplateVersion>()).ExecuteCommandAsync();
     }
 
+    /// <summary>
+    /// 启用或停用合同模板版本。
+    /// </summary>
     public async Task SetVersionStatus(OnboardingContractVersionStatusInput input)
     {
         if (input.VersionStatus != ContractTemplateVersionStatus.Enabled
@@ -108,6 +132,9 @@ public class OnboardingContractTemplateService : DbRepository<ObContractTemplate
         await Context.Updateable(version).ExecuteCommandAsync();
     }
 
+    /// <summary>
+    /// 分页查询指定模板版本的变量定义。
+    /// </summary>
     public async Task<SqlSugarPagedList<ObTemplateVariable>> VariablePage(OnboardingTemplateVariablePageInput input)
     {
         return await Context.Queryable<ObTemplateVariable>()
@@ -117,6 +144,9 @@ public class OnboardingContractTemplateService : DbRepository<ObContractTemplate
             .ToPagedListAsync(input.PageNum, input.PageSize);
     }
 
+    /// <summary>
+    /// 为草稿模板版本新增变量。
+    /// </summary>
     public async Task AddVariable(OnboardingTemplateVariableAddInput input)
     {
         await EnsureVersionDraft(input.TemplateVersionId);
@@ -124,6 +154,9 @@ public class OnboardingContractTemplateService : DbRepository<ObContractTemplate
         await Context.Insertable(input.Adapt<ObTemplateVariable>()).ExecuteCommandAsync();
     }
 
+    /// <summary>
+    /// 编辑草稿模板版本中的变量。
+    /// </summary>
     public async Task EditVariable(OnboardingTemplateVariableEditInput input)
     {
         var variable = await Context.Queryable<ObTemplateVariable>().InSingleAsync(input.Id)
@@ -136,6 +169,9 @@ public class OnboardingContractTemplateService : DbRepository<ObContractTemplate
         await Context.Updateable(input.Adapt<ObTemplateVariable>()).ExecuteCommandAsync();
     }
 
+    /// <summary>
+    /// 删除草稿模板版本中的变量。
+    /// </summary>
     public async Task DeleteVariable(BaseIdListInput input)
     {
         if (input.Ids.Count == 0)
@@ -152,6 +188,9 @@ public class OnboardingContractTemplateService : DbRepository<ObContractTemplate
         await Context.Deleteable<ObTemplateVariable>().In(input.Ids).ExecuteCommandAsync();
     }
 
+    /// <summary>
+    /// 分页查询合同适用范围。
+    /// </summary>
     public async Task<SqlSugarPagedList<ObContractScope>> ScopePage(OnboardingContractScopePageInput input)
     {
         return await Context.Queryable<ObContractScope>()
@@ -162,6 +201,9 @@ public class OnboardingContractTemplateService : DbRepository<ObContractTemplate
             .ToPagedListAsync(input.PageNum, input.PageSize);
     }
 
+    /// <summary>
+    /// 新增公司或岗位的合同适用范围。
+    /// </summary>
     public async Task AddScope(OnboardingContractScopeAddInput input)
     {
         await EnsureScopeValid(input.CompanyId, input.PositionId, input.TemplateId, input.TemplateVersionId);
@@ -169,6 +211,9 @@ public class OnboardingContractTemplateService : DbRepository<ObContractTemplate
         await Context.Insertable(input.Adapt<ObContractScope>()).ExecuteCommandAsync();
     }
 
+    /// <summary>
+    /// 编辑合同适用范围。
+    /// </summary>
     public async Task EditScope(OnboardingContractScopeEditInput input)
     {
         var scopeExists = await Context.Queryable<ObContractScope>().AnyAsync(it => it.Id == input.Id);
@@ -180,6 +225,9 @@ public class OnboardingContractTemplateService : DbRepository<ObContractTemplate
         await Context.Updateable(input.Adapt<ObContractScope>()).ExecuteCommandAsync();
     }
 
+    /// <summary>
+    /// 删除合同适用范围。
+    /// </summary>
     public async Task DeleteScope(BaseIdListInput input)
     {
         if (input.Ids.Count == 0)