补充注释

2026-08-24 15:32:50 +08:00
parent b8b2d7e3fa
commit 22a7df5bec
84 changed files with 5913 additions and 45 deletions
@@ -1,35 +1,101 @@
 namespace SimpleAdmin.Application;

+/// <summary>
+/// 模板变量分页查询参数。
+/// </summary>
 public class OnboardingTemplateVariablePageInput : BasePageInput
 {
+    /// <summary>
+    /// 合同模板版本 Id。
+    /// </summary>
    [IdNotNull(ErrorMessage = "模板版本Id不能为空")]
    public long TemplateVersionId { get; set; }
 }

+/// <summary>
+/// 新增模板变量参数。
+/// </summary>
 public class OnboardingTemplateVariableAddInput
 {
+    /// <summary>
+    /// 合同模板版本 Id。
+    /// </summary>
    [IdNotNull(ErrorMessage = "模板版本Id不能为空")]
    public long TemplateVersionId { get; set; }
+
+    /// <summary>
+    /// 合同变量编码。
+    /// </summary>
    [global::System.ComponentModel.DataAnnotations.Required(ErrorMessage = "变量编码不能为空")]
    public string VariableCode { get; set; }
+
+    /// <summary>
+    /// 合同变量名称。
+    /// </summary>
    [global::System.ComponentModel.DataAnnotations.Required(ErrorMessage = "变量名称不能为空")]
    public string VariableName { get; set; }
+
+    /// <summary>
+    /// 合同变量来源类型。
+    /// </summary>
    [global::System.ComponentModel.DataAnnotations.Required(ErrorMessage = "变量类型不能为空")]
    public string VariableType { get; set; }
+
+    /// <summary>
+    /// 字段或变量数据类型。
+    /// </summary>
    [global::System.ComponentModel.DataAnnotations.Required(ErrorMessage = "数据类型不能为空")]
    public string DataType { get; set; }
+
+    /// <summary>
+    /// 关联的候选人基础信息字段。
+    /// </summary>
    public string EmployeeField { get; set; }
+
+    /// <summary>
+    /// 默认值。
+    /// </summary>
    public string DefaultValue { get; set; }
+
+    /// <summary>
+    /// 可选项 JSON。
+    /// </summary>
    public string OptionsJson { get; set; }
+
+    /// <summary>
+    /// 格式化规则。
+    /// </summary>
    public string FormatRule { get; set; }
+
+    /// <summary>
+    /// 是否必填、必传或必签。
+    /// </summary>
    public bool Required { get; set; }
+
+    /// <summary>
+    /// 人事是否可以编辑。
+    /// </summary>
    public bool HrEditable { get; set; }
+
+    /// <summary>
+    /// 显示排序码。
+    /// </summary>
    public int? SortCode { get; set; }
+
+    /// <summary>
+    /// 业务备注。
+    /// </summary>
    public string Remark { get; set; }
 }

+/// <summary>
+/// 编辑模板变量参数。
+/// </summary>
 public class OnboardingTemplateVariableEditInput : OnboardingTemplateVariableAddInput
 {
+    /// <summary>
+    /// 业务数据 Id。
+    /// </summary>
    [IdNotNull(ErrorMessage = "变量Id不能为空")]
    public long Id { get; set; }
 }