补充注释

SimpleAdmin.Web.Core/Controllers/Application/Onboarding/OnboardingContractTemplateController.cs

@@ -1,5 +1,8 @@
 namespace SimpleAdmin.Web.Core;
 
+/// <summary>
+/// 提供合同模板、版本、变量和适用范围相关 HTTP 接口。
+/// </summary>
 [ApiDescriptionSettings("Application", Tag = "入职合同模板")]
 [Route("biz/onboarding/contract-template")]
 [RolePermission]
@@ -12,99 +15,147 @@ public class OnboardingContractTemplateController
         _service = service;
     }
 
+    /// <summary>
+    /// 分页查询合同模板。
+    /// </summary>
     [HttpGet("page")]
     public async Task<dynamic> Page([FromQuery] OnboardingContractTemplatePageInput input)
     {
         return await _service.Page(input);
     }
 
+    /// <summary>
+    /// 查询合同模板详情。
+    /// </summary>
     [HttpGet("detail")]
     public async Task<dynamic> Detail([FromQuery] BaseIdInput input)
     {
         return await _service.Detail(input);
     }
 
+    /// <summary>
+    /// 新增合同模板。
+    /// </summary>
     [HttpPost("add")]
     public async Task Add([FromBody] OnboardingContractTemplateAddInput input)
     {
         await _service.Add(input);
     }
 
+    /// <summary>
+    /// 编辑合同模板。
+    /// </summary>
     [HttpPost("edit")]
     public async Task Edit([FromBody] OnboardingContractTemplateEditInput input)
     {
         await _service.Edit(input);
     }
 
+    /// <summary>
+    /// 删除合同模板。
+    /// </summary>
     [HttpPost("delete")]
     public async Task Delete([FromBody] BaseIdListInput input)
     {
         await _service.Delete(input);
     }
 
+    /// <summary>
+    /// 分页查询合同模板版本。
+    /// </summary>
     [HttpGet("version/page")]
     public async Task<dynamic> VersionPage([FromQuery] OnboardingContractVersionPageInput input)
     {
         return await _service.VersionPage(input);
     }
 
+    /// <summary>
+    /// 新增合同模板版本。
+    /// </summary>
     [HttpPost("version/add")]
     public async Task AddVersion([FromBody] OnboardingContractVersionAddInput input)
     {
         await _service.AddVersion(input);
     }
 
+    /// <summary>
+    /// 设置合同模板版本状态。
+    /// </summary>
     [HttpPost("version/set-status")]
     public async Task SetVersionStatus([FromBody] OnboardingContractVersionStatusInput input)
     {
         await _service.SetVersionStatus(input);
     }
 
+    /// <summary>
+    /// 分页查询模板变量。
+    /// </summary>
     [HttpGet("variable/page")]
     public async Task<dynamic> VariablePage([FromQuery] OnboardingTemplateVariablePageInput input)
     {
         return await _service.VariablePage(input);
     }
 
+    /// <summary>
+    /// 新增模板变量。
+    /// </summary>
     [HttpPost("variable/add")]
     public async Task AddVariable([FromBody] OnboardingTemplateVariableAddInput input)
     {
         await _service.AddVariable(input);
     }
 
+    /// <summary>
+    /// 编辑模板变量。
+    /// </summary>
     [HttpPost("variable/edit")]
     public async Task EditVariable([FromBody] OnboardingTemplateVariableEditInput input)
     {
         await _service.EditVariable(input);
     }
 
+    /// <summary>
+    /// 删除模板变量。
+    /// </summary>
     [HttpPost("variable/delete")]
     public async Task DeleteVariable([FromBody] BaseIdListInput input)
     {
         await _service.DeleteVariable(input);
     }
 
+    /// <summary>
+    /// 分页查询合同适用范围。
+    /// </summary>
     [HttpGet("scope/page")]
     public async Task<dynamic> ScopePage([FromQuery] OnboardingContractScopePageInput input)
     {
         return await _service.ScopePage(input);
     }
 
+    /// <summary>
+    /// 新增合同适用范围。
+    /// </summary>
     [HttpPost("scope/add")]
     public async Task AddScope([FromBody] OnboardingContractScopeAddInput input)
     {
         await _service.AddScope(input);
     }
 
+    /// <summary>
+    /// 编辑合同适用范围。
+    /// </summary>
     [HttpPost("scope/edit")]
     public async Task EditScope([FromBody] OnboardingContractScopeEditInput input)
     {
         await _service.EditScope(input);
     }
 
+    /// <summary>
+    /// 删除合同适用范围。
+    /// </summary>
     [HttpPost("scope/delete")]
     public async Task DeleteScope([FromBody] BaseIdListInput input)
     {
         await _service.DeleteScope(input);
     }
-}
+}