添加注释

Data/Entities/DbVariableData.cs

@@ -4,123 +4,126 @@ using SqlSugar.DbConvert;
 
 namespace PMSWPF.Data.Entities;
 
+/// <summary>
+/// 表示数据库中的变量数据实体。
+/// </summary>
 [SugarTable("VarData")]
 public class DbVariableData
 {
     /// <summary>
-    /// 变量唯一标识符
+    /// 报警的最大值阈值。
     /// </summary>
-    [SugarColumn(IsPrimaryKey = true, IsIdentity = true)] //数据库是自增才配自增 
-    public int Id { get; set; }
+    public double AlarmMax { get; set; }
 
     /// <summary>
-    /// 关联的变量表ID
+    /// 报警的最小值阈值。
     /// </summary>
-    public int VariableTableId { get; set; }
+    public double AlarmMin { get; set; }
 
     /// <summary>
-    /// 关联的变量表实体
+    /// 数据转换规则或表达式。
     /// </summary>
-    [Navigate(NavigateType.ManyToOne, nameof(VariableTableId))]
-    public DbVariableTable? VariableTable { get; set; }
+    public string Converstion { get; set; } = String.Empty;
 
     /// <summary>
-    /// 变量名称
+    /// 数据类型，例如Int、Float、String等。
     /// </summary>
-    public string Name { get; set; }
+    public string DataType { get; set; } = String.Empty;
 
     /// <summary>
-    /// 变量描述
+    /// 变量当前原始数据值。
+    /// </summary>
+    public string DataValue { get; set; } = String.Empty;
+
+    /// <summary>
+    /// 变量描述。
     /// </summary>
     [SugarColumn(IsNullable = true)]
     public string? Description { get; set; }
 
     /// <summary>
-    /// 节点ID，用于标识变量在设备或系统中的唯一路径
-    /// </summary>
-    public string NodeId { get; set; } = String.Empty;
-
-    /// <summary>
-    /// 协议类型，例如Modbus、OPC UA等
-    /// </summary>
-    [SugarColumn(ColumnDataType = "varchar(20)", SqlParameterDbType = typeof(EnumToStringConvert))]
-    public ProtocolType ProtocolType { get; set; }
-
-    /// <summary>
-    /// 数据类型，例如Int、Float、String等
-    /// </summary>
-    public string DataType { get; set; }=String.Empty;
-
-    /// <summary>
-    /// 信号类型，例如模拟量、数字量等
-    /// </summary>
-    [SugarColumn(ColumnDataType = "varchar(20)", IsNullable = true, SqlParameterDbType = typeof(EnumToStringConvert))]
-    public SignalType SignalType { get; set; }
-
-    /// <summary>
-    /// 变量当前原始数据值
-    /// </summary>
-    public string DataValue { get; set; } = String.Empty;
-
-    /// <summary>
-    /// 变量经过转换或格式化后的显示值
+    /// 变量经过转换或格式化后的显示值。
     /// </summary>
     public string DisplayValue { get; set; } = String.Empty;
 
     /// <summary>
-    /// 变量数据最后更新时间
+    /// 变量唯一标识符。
     /// </summary>
-    public DateTime UpdateTime { get; set; } = DateTime.Now;
+    [SugarColumn(IsPrimaryKey = true, IsIdentity = true)] //数据库是自增才配自增 
+    public int Id { get; set; }
 
     /// <summary>
-    /// 最后更新变量数据的用户
+    /// 指示是否需要对变量进行报警监测。
     /// </summary>
-    [SugarColumn(IsNullable = true)]
-    public DbUser? UpdateUser { get; set; }
+    public bool IsAlarm { get; set; }
 
     /// <summary>
-    /// 关联的MQTT配置列表
+    /// 指示变量是否处于激活状态。
+    /// </summary>
+    public bool IsActive { get; set; }
+
+    /// <summary>
+    /// 指示变量是否已被逻辑删除。
+    /// </summary>
+    public bool IsDeleted { get; set; }
+
+    /// <summary>
+    /// 指示是否需要保存变量数据。
+    /// </summary>
+    public bool IsSave { get; set; }
+
+    /// <summary>
+    /// 关联的MQTT配置列表。
     /// </summary>
     [SugarColumn(IsNullable = true)]
     public List<DbMqtt>? Mqtts { get; set; }
 
     /// <summary>
-    /// 数据转换规则或表达式
+    /// 变量名称。
     /// </summary>
-    public string Converstion { get; set; } = String.Empty;
+    public string Name { get; set; }
 
     /// <summary>
-    /// 指示变量是否处于激活状态
+    /// 节点ID，用于标识变量在设备或系统中的唯一路径。
     /// </summary>
-    public bool IsActive { get; set; }
+    public string NodeId { get; set; } = String.Empty;
 
     /// <summary>
-    /// 指示是否需要保存变量数据
+    /// 协议类型，例如Modbus、OPC UA等。
     /// </summary>
-    public bool IsSave { get; set; }
+    [SugarColumn(ColumnDataType = "varchar(20)", SqlParameterDbType = typeof(EnumToStringConvert))]
+    public ProtocolType ProtocolType { get; set; }
 
     /// <summary>
-    /// 数据保存的范围或阈值
+    /// 数据保存的范围或阈值。
     /// </summary>
     public double SaveRange { get; set; }
 
     /// <summary>
-    /// 指示是否需要对变量进行报警监测
+    /// 信号类型，例如模拟量、数字量等。
     /// </summary>
-    public bool IsAlarm { get; set; }
+    [SugarColumn(ColumnDataType = "varchar(20)", IsNullable = true, SqlParameterDbType = typeof(EnumToStringConvert))]
+    public SignalType SignalType { get; set; }
 
     /// <summary>
-    /// 报警的最小值阈值
+    /// 变量数据最后更新时间。
     /// </summary>
-    public double AlarmMin { get; set; }
+    public DateTime UpdateTime { get; set; } = DateTime.Now;
 
     /// <summary>
-    /// 报警的最大值阈值
+    /// 最后更新变量数据的用户。
     /// </summary>
-    public double AlarmMax { get; set; }
+    [SugarColumn(IsNullable = true)]
+    public DbUser? UpdateUser { get; set; }
 
     /// <summary>
-    /// 指示变量是否已被逻辑删除
+    /// 关联的变量表实体。
     /// </summary>
-    public bool IsDeleted { get; set; }
+    [Navigate(NavigateType.ManyToOne, nameof(VariableTableId))]
+    public DbVariableTable? VariableTable { get; set; }
+
+    /// <summary>
+    /// 关联的变量表ID。
+    /// </summary>
+    public int VariableTableId { get; set; }
 }