补充注释

SimpleAdmin.Application/Services/Onboarding/TaskContractVariable/Dto/OnboardingTaskContractVariableInput.cs

@@ -1,43 +1,125 @@
 namespace SimpleAdmin.Application;
 
+/// <summary>
+/// 查询任务合同变量参数。
+/// </summary>
 public class OnboardingTaskContractVariableQueryInput
 {
+    /// <summary>
+    /// 入职任务 Id。
+    /// </summary>
     [IdNotNull(ErrorMessage = "入职任务Id不能为空")]
     public long TaskId { get; set; }
 }
 
+/// <summary>
+/// 批量保存任务合同变量参数。
+/// </summary>
 public class OnboardingTaskContractVariableSaveInput
 {
+    /// <summary>
+    /// 任务合同 Id。
+    /// </summary>
     [IdNotNull(ErrorMessage = "任务合同Id不能为空")]
     public long TaskContractId { get; set; }
+
+    /// <summary>
+    /// 待保存的字段或变量值集合。
+    /// </summary>
     [global::System.ComponentModel.DataAnnotations.Required(ErrorMessage = "变量不能为空")]
     public List<OnboardingTaskContractVariableValueInput> Values { get; set; } = new List<OnboardingTaskContractVariableValueInput>();
 }
 
+/// <summary>
+/// 单个任务合同变量保存值。
+/// </summary>
 public class OnboardingTaskContractVariableValueInput
 {
+    /// <summary>
+    /// 业务数据 Id。
+    /// </summary>
     [IdNotNull(ErrorMessage = "变量Id不能为空")]
     public long Id { get; set; }
+
+    /// <summary>
+    /// 任务合同变量最终值。
+    /// </summary>
     public string VariableValue { get; set; }
 }
 
+/// <summary>
+/// 单份任务合同及其变量输出。
+/// </summary>
 public class OnboardingTaskContractVariableOutput
 {
+    /// <summary>
+    /// 任务合同 Id。
+    /// </summary>
     public long TaskContractId { get; set; }
+
+    /// <summary>
+    /// 任务合同名称。
+    /// </summary>
     public string ContractName { get; set; }
+
+    /// <summary>
+    /// 合同类型。
+    /// </summary>
     public string ContractType { get; set; }
+
+    /// <summary>
+    /// 任务合同变量列表。
+    /// </summary>
     public List<OnboardingTaskContractVariableItemOutput> Variables { get; set; } = new List<OnboardingTaskContractVariableItemOutput>();
 }
 
+/// <summary>
+/// 单个任务合同变量输出。
+/// </summary>
 public class OnboardingTaskContractVariableItemOutput
 {
+    /// <summary>
+    /// 业务数据 Id。
+    /// </summary>
     public long Id { get; set; }
+
+    /// <summary>
+    /// 合同变量编码。
+    /// </summary>
     public string VariableCode { get; set; }
+
+    /// <summary>
+    /// 合同变量名称。
+    /// </summary>
     public string VariableName { get; set; }
+
+    /// <summary>
+    /// 合同变量来源类型。
+    /// </summary>
     public string VariableType { get; set; }
+
+    /// <summary>
+    /// 字段或变量数据类型。
+    /// </summary>
     public string DataType { get; set; }
+
+    /// <summary>
+    /// 任务合同变量最终值。
+    /// </summary>
     public string VariableValue { get; set; }
+
+    /// <summary>
+    /// 是否必填、必传或必签。
+    /// </summary>
     public bool Required { get; set; }
+
+    /// <summary>
+    /// 人事是否可以编辑。
+    /// </summary>
     public bool HrEditable { get; set; }
+
+    /// <summary>
+    /// 当前用户是否可以编辑该变量。
+    /// </summary>
     public bool Editable { get; set; }
-}
+}