Skip to content

Commit 843d905

Browse files
AlianBlankAlianBlank
committed
docs(orm-entity): 为实体类和过滤器接口添加双语文档注释
- 为 IEntity、EntityBase、EntityBaseId 等实体基类添加中英文文档注释 - 为 IAuditableEntity、IVersionedEntity 接口添加双语文档 - 为 EntityTenantBase、EntitySelectBase 多租户和选择查询基类添加注释 - 为 Filter 目录下所有过滤器接口添加双语文档注释 - 遵循 summary 中文 + remarks 英文的双语注释规范
1 parent c0cd97a commit 843d905

14 files changed

Lines changed: 372 additions & 89 deletions

‎GameFrameX.Foundation.Orm.Entity/EntityBase.cs‎

Lines changed: 139 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -37,177 +37,281 @@
3737
namespace GameFrameX.Foundation.Orm.Entity;
3838

3939
/// <summary>
40-
/// 框架实体基类
40+
/// 框架实体基类。
4141
/// </summary>
42+
/// <remarks>
43+
/// Framework entity base class.
44+
/// </remarks>
4245
public abstract class EntityBase : EntityBaseId, ISafeDeletedFilter, IVersionedEntity, ISafeEnabledFilter, ISafeCreatedFilter, ISafeUpdateFilter
4346
{
4447
/// <summary>
45-
/// 创建人Id
48+
/// 获取或设置创建人Id。
4649
/// </summary>
50+
/// <remarks>
51+
/// Gets or sets the creator ID.
52+
/// </remarks>
53+
/// <value>创建人Id / Creator ID</value>
4754
[Description("创建人Id")]
4855
public virtual long? CreatedId { get; set; }
4956

5057
/// <summary>
51-
/// 创建时间
58+
/// 获取或设置创建时间。
5259
/// </summary>
60+
/// <remarks>
61+
/// Gets or sets the creation time.
62+
/// </remarks>
63+
/// <value>创建时间 / Creation time</value>
5364
[Description("创建时间")]
5465
public virtual long CreatedTime { get; set; }
5566

5667
/// <summary>
57-
/// 创建人姓名
68+
/// 获取或设置创建人姓名。
5869
/// </summary>
70+
/// <remarks>
71+
/// Gets or sets the creator name.
72+
/// </remarks>
73+
/// <value>创建人姓名 / Creator name</value>
5974
[Description("创建人姓名")]
6075
public virtual string? CreatedName { get; set; }
6176

6277
/// <summary>
63-
/// 更新次数
78+
/// 获取或设置更新次数。
6479
/// </summary>
80+
/// <remarks>
81+
/// Gets or sets the update count.
82+
/// </remarks>
83+
/// <value>更新次数 / Update count</value>
6584
[Description("更新次数")]
6685
public virtual int? UpdateCount { get; set; }
6786

6887
/// <summary>
69-
/// 更新时间
88+
/// 获取或设置更新时间。
7089
/// </summary>
90+
/// <remarks>
91+
/// Gets or sets the update time.
92+
/// </remarks>
93+
/// <value>更新时间 / Update time</value>
7194
[Description("更新时间")]
7295
public virtual long? UpdateTime { get; set; }
7396

7497
/// <summary>
75-
/// 更新人Id
98+
/// 获取或设置更新人Id。
7699
/// </summary>
100+
/// <remarks>
101+
/// Gets or sets the updater ID.
102+
/// </remarks>
103+
/// <value>更新人Id / Updater ID</value>
77104
[Description("更新人Id")]
78105
public virtual long? UpdatedId { get; set; }
79106

80107
/// <summary>
81-
/// 更新人姓名
108+
/// 获取或设置更新人姓名。
82109
/// </summary>
110+
/// <remarks>
111+
/// Gets or sets the updater name.
112+
/// </remarks>
113+
/// <value>更新人姓名 / Updater name</value>
83114
[Description("更新人姓名")]
84115
public virtual string? UpdatedName { get; set; }
85116

86117
/// <summary>
87-
/// 软删除
118+
/// 获取或设置软删除标记。
88119
/// </summary>
120+
/// <remarks>
121+
/// Gets or sets the soft delete flag.
122+
/// </remarks>
123+
/// <value><c>true</c> 表示已删除；<c>false</c> 表示未删除；<c>null</c> 表示未设置（未删除） / <c>true</c> for deleted; <c>false</c> for not deleted; <c>null</c> for unset (not deleted)</value>
89124
[Description("软删除标记,true:删除,false:未删除,null:未设置(未删除)")]
90125
public virtual bool? IsDeleted { get; set; } = false;
91126

92127
/// <summary>
93-
/// 删除时间
128+
/// 获取或设置删除时间。
94129
/// </summary>
130+
/// <remarks>
131+
/// Gets or sets the deletion time.
132+
/// </remarks>
133+
/// <value>删除时间 / Deletion time</value>
95134
[Description("删除时间")]
96135
public virtual long? DeleteTime { get; set; }
97136

98137
/// <summary>
99-
/// 删除人Id
138+
/// 获取或设置删除人Id。
100139
/// </summary>
140+
/// <remarks>
141+
/// Gets or sets the deleter ID.
142+
/// </remarks>
143+
/// <value>删除人Id / Deleter ID</value>
101144
[Description("删除人Id")]
102145
public virtual long? DeletedId { get; set; }
103146

104147
/// <summary>
105-
/// 删除人姓名
148+
/// 获取或设置删除人姓名。
106149
/// </summary>
150+
/// <remarks>
151+
/// Gets or sets the deleter name.
152+
/// </remarks>
153+
/// <value>删除人姓名 / Deleter name</value>
107154
[Description("删除人姓名")]
108155
public virtual string? DeletedName { get; set; }
109156

110157
/// <summary>
111-
/// 版本号（用于乐观锁）
158+
/// 获取或设置版本号（用于乐观锁）。
112159
/// </summary>
160+
/// <remarks>
161+
/// Gets or sets the version number (used for optimistic locking).
162+
/// </remarks>
163+
/// <value>版本号（用于乐观锁） / Version number (for optimistic locking)</value>
113164
[Description("版本号（用于乐观锁）")]
114165
public virtual long? Version { get; set; } = 0;
115166

116167
/// <summary>
117-
/// 是否启用该实体或功能的标识
168+
/// 获取或设置是否启用该实体或功能的标识。
118169
/// </summary>
119-
/// <value>
120-
/// true表示启用，false表示禁用，null表示未设置
121-
/// </value>
170+
/// <remarks>
171+
/// Gets or sets the flag indicating whether the entity or feature is enabled.
172+
/// </remarks>
173+
/// <value><c>true</c> 表示启用；<c>false</c> 表示禁用；<c>null</c> 表示未设置（启用） / <c>true</c> for enabled; <c>false</c> for disabled; <c>null</c> for unset (enabled)</value>
122174
[Description("是否启用,true:启用，false:禁用，null:未设置(启用)")]
123175
public virtual bool? IsEnabled { get; set; }
124176
}
125177

126178
/// <summary>
127-
/// 泛型框架实体基类
179+
/// 泛型框架实体基类。
128180
/// </summary>
129-
/// <typeparam name="TKey">主键类型</typeparam>
181+
/// <remarks>
182+
/// Generic framework entity base class.
183+
/// </remarks>
184+
/// <typeparam name="TKey">主键类型 / Primary key type</typeparam>
130185
public abstract class EntityBase<TKey> : EntityBaseId<TKey>, ISafeDeletedFilter, IVersionedEntity, ISafeEnabledFilter, ISafeCreatedFilter, ISafeUpdateFilter
131186
where TKey : notnull
132187
{
133188
/// <summary>
134-
/// 创建人Id
189+
/// 获取或设置创建人Id。
135190
/// </summary>
191+
/// <remarks>
192+
/// Gets or sets the creator ID.
193+
/// </remarks>
194+
/// <value>创建人Id / Creator ID</value>
136195
[Description("创建人Id")]
137196
public virtual long? CreatedId { get; set; }
138197

139198
/// <summary>
140-
/// 创建时间
199+
/// 获取或设置创建时间。
141200
/// </summary>
201+
/// <remarks>
202+
/// Gets or sets the creation time.
203+
/// </remarks>
204+
/// <value>创建时间 / Creation time</value>
142205
[Description("创建时间")]
143206
public virtual long CreatedTime { get; set; }
144207

145208
/// <summary>
146-
/// 创建人姓名
209+
/// 获取或设置创建人姓名。
147210
/// </summary>
211+
/// <remarks>
212+
/// Gets or sets the creator name.
213+
/// </remarks>
214+
/// <value>创建人姓名 / Creator name</value>
148215
[Description("创建人姓名")]
149216
public virtual string? CreatedName { get; set; }
150217

151218
/// <summary>
152-
/// 更新次数
219+
/// 获取或设置更新次数。
153220
/// </summary>
221+
/// <remarks>
222+
/// Gets or sets the update count.
223+
/// </remarks>
224+
/// <value>更新次数 / Update count</value>
154225
[Description("更新次数")]
155226
public virtual int? UpdateCount { get; set; }
156227

157228
/// <summary>
158-
/// 更新时间
229+
/// 获取或设置更新时间。
159230
/// </summary>
231+
/// <remarks>
232+
/// Gets or sets the update time.
233+
/// </remarks>
234+
/// <value>更新时间 / Update time</value>
160235
[Description("更新时间")]
161236
public virtual long? UpdateTime { get; set; }
162237

163238
/// <summary>
164-
/// 更新人Id
239+
/// 获取或设置更新人Id。
165240
/// </summary>
241+
/// <remarks>
242+
/// Gets or sets the updater ID.
243+
/// </remarks>
244+
/// <value>更新人Id / Updater ID</value>
166245
[Description("更新人Id")]
167246
public virtual long? UpdatedId { get; set; }
168247

169248
/// <summary>
170-
/// 更新人姓名
249+
/// 获取或设置更新人姓名。
171250
/// </summary>
251+
/// <remarks>
252+
/// Gets or sets the updater name.
253+
/// </remarks>
254+
/// <value>更新人姓名 / Updater name</value>
172255
[Description("更新人姓名")]
173256
public virtual string? UpdatedName { get; set; }
174257

175258
/// <summary>
176-
/// 软删除
259+
/// 获取或设置软删除标记。
177260
/// </summary>
261+
/// <remarks>
262+
/// Gets or sets the soft delete flag.
263+
/// </remarks>
264+
/// <value><c>true</c> 表示已删除；<c>false</c> 表示未删除；<c>null</c> 表示未设置（未删除） / <c>true</c> for deleted; <c>false</c> for not deleted; <c>null</c> for unset (not deleted)</value>
178265
[Description("软删除标记,true:删除,false:未删除,null:未设置(未删除)")]
179266
public virtual bool? IsDeleted { get; set; } = false;
180267

181268
/// <summary>
182-
/// 删除时间
269+
/// 获取或设置删除时间。
183270
/// </summary>
271+
/// <remarks>
272+
/// Gets or sets the deletion time.
273+
/// </remarks>
274+
/// <value>删除时间 / Deletion time</value>
184275
[Description("删除时间")]
185276
public virtual long? DeleteTime { get; set; }
186277

187278
/// <summary>
188-
/// 删除人Id
279+
/// 获取或设置删除人Id。
189280
/// </summary>
281+
/// <remarks>
282+
/// Gets or sets the deleter ID.
283+
/// </remarks>
284+
/// <value>删除人Id / Deleter ID</value>
190285
[Description("删除人Id")]
191286
public virtual long? DeletedId { get; set; }
192287

193288
/// <summary>
194-
/// 删除人姓名
289+
/// 获取或设置删除人姓名。
195290
/// </summary>
291+
/// <remarks>
292+
/// Gets or sets the deleter name.
293+
/// </remarks>
294+
/// <value>删除人姓名 / Deleter name</value>
196295
[Description("删除人姓名")]
197296
public virtual string? DeletedName { get; set; }
198297

199298
/// <summary>
200-
/// 版本号（用于乐观锁）
299+
/// 获取或设置版本号（用于乐观锁）。
201300
/// </summary>
301+
/// <remarks>
302+
/// Gets or sets the version number (used for optimistic locking).
303+
/// </remarks>
304+
/// <value>版本号（用于乐观锁） / Version number (for optimistic locking)</value>
202305
[Description("版本号（用于乐观锁）")]
203306
public virtual long? Version { get; set; } = 0;
204307

205308
/// <summary>
206-
/// 是否启用该实体或功能的标识
309+
/// 获取或设置是否启用该实体或功能的标识。
207310
/// </summary>
208-
/// <value>
209-
/// true表示启用，false表示禁用，null表示未设置
210-
/// </value>
311+
/// <remarks>
312+
/// Gets or sets the flag indicating whether the entity or feature is enabled.
313+
/// </remarks>
314+
/// <value><c>true</c> 表示启用；<c>false</c> 表示禁用；<c>null</c> 表示未设置（启用） / <c>true</c> for enabled; <c>false</c> for disabled; <c>null</c> for unset (enabled)</value>
211315
[Description("是否启用,true:启用，false:禁用，null:未设置(启用)")]
212316
public virtual bool? IsEnabled { get; set; }
213317
}

‎GameFrameX.Foundation.Orm.Entity/EntityBaseId.cs‎

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,20 @@
3636
namespace GameFrameX.Foundation.Orm.Entity;
3737

3838
/// <summary>
39-
/// 框架实体基类Id
39+
/// 框架实体基类Id。
4040
/// </summary>
41+
/// <remarks>
42+
/// Framework entity base class with ID.
43+
/// </remarks>
4144
public abstract class EntityBaseId : IEntity<long>
4245
{
4346
/// <summary>
44-
/// 主键Id
47+
/// 获取或设置主键Id。
4548
/// </summary>
49+
/// <remarks>
50+
/// Gets or sets the primary key ID.
51+
/// </remarks>
52+
/// <value>主键Id / Primary key ID</value>
4653
[Key]
4754
[Required]
4855
[Editable(false, AllowInitialValue = true)]
@@ -51,15 +58,22 @@ public abstract class EntityBaseId : IEntity<long>
5158
}
5259

5360
/// <summary>
54-
/// 泛型实体基类Id
61+
/// 泛型实体基类Id。
5562
/// </summary>
56-
/// <typeparam name="TKey">主键类型</typeparam>
63+
/// <remarks>
64+
/// Generic entity base class with ID.
65+
/// </remarks>
66+
/// <typeparam name="TKey">主键类型 / Primary key type</typeparam>
5767
public abstract class EntityBaseId<TKey> : IEntity<TKey>
5868
where TKey : notnull
5969
{
6070
/// <summary>
61-
/// 主键Id
71+
/// 获取或设置主键Id。
6272
/// </summary>
73+
/// <remarks>
74+
/// Gets or sets the primary key ID.
75+
/// </remarks>
76+
/// <value>主键Id / Primary key ID</value>
6377
[Key]
6478
[Required]
6579
[Editable(false, AllowInitialValue = true)]

0 commit comments

Comments
 (0)