[增加]1. 增加DBServer 注释

Author: AlianBlank

DataBaseServer/GameFrameX.DBServer/DbService/MongoDB/MongoDBExtensions.cs

@@ -2,6 +2,9 @@
 
 namespace GameFrameX.DBServer.DbService.MongoDB;
 
+/// <summary>
+/// MongoDB扩展
+/// </summary>
 public static class MongoDbExtensions
 {
     /// <summary>

DataBaseServer/GameFrameX.DBServer/DbService/MongoDB/MongoState.cs

@@ -1,5 +1,8 @@
 namespace GameFrameX.DBServer.DbService.MongoDB
 {
+    /// <summary>
+    /// 
+    /// </summary>
     public class MongoState
     {
         /// <summary>

DataBaseServer/GameFrameX.DBServer/GameDB.cs

@@ -75,7 +75,7 @@ public static void Close()
         /// <typeparam name="TState">文档的类型</typeparam>
         /// <param name="filter">过滤器表达式</param>
         /// <returns>表示异步操作的任务。任务结果包含文档</returns>
-        public static Task<TState?> FindAsync<TState>(Expression<Func<TState, bool>> filter) where TState : ICacheState, new()
+        public static Task<TState> FindAsync<TState>(Expression<Func<TState, bool>> filter) where TState : ICacheState, new()
         {
             return _dbServiceImpler.FindAsync<TState>(filter);
         }

DataBaseServer/GameFrameX.DBServer/IGameDbService.cs

@@ -35,7 +35,7 @@ public interface IGameDbService
     /// <param name="filter">查询条件</param>
     /// <typeparam name="TState"></typeparam>
     /// <returns></returns>
-    public Task<TState?> FindAsync<TState>(Expression<Func<TState, bool>> filter) where TState : ICacheState, new();
+    public Task<TState> FindAsync<TState>(Expression<Func<TState, bool>> filter) where TState : ICacheState, new();
 
     /// <summary>
     /// 查询数据

DataBaseServer/GameFrameX.DBServer/State/CacheState.cs

@@ -4,14 +4,13 @@
 
 namespace GameFrameX.DBServer.State
 {
+    /// <summary>
+    /// 缓存数据对象
+    /// </summary>
     [BsonIgnoreExtraElements(true, Inherited = true)]
     [ProtoContract]
     public class CacheState : ICacheState
     {
-        public CacheState()
-        {
-        }
-
         /// <summary>
         /// 唯一ID。给DB用的
         /// </summary>
@@ -24,9 +23,16 @@ public CacheState()
         [ProtoMember(888)]
         public long Id { get; set; }
 
+        /// <summary>
+        /// 是否修改
+        /// </summary>
         public bool IsModify => IsChanged().isChanged;
 
 
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <returns></returns>
         public override string ToString()
         {
             return $"{base.ToString()}[Id={Id}]";
@@ -41,11 +47,19 @@ public void AfterLoadFromDB(bool isNew)
             stateHash = new StateHash(this, isNew);
         }
 
+        /// <summary>
+        /// 是否修改
+        /// </summary>
+        /// <returns></returns>
         public (bool isChanged, byte[] data) IsChanged()
         {
             return stateHash.IsChanged();
         }
 
+        /// <summary>
+        /// 是否由ID引起的变化
+        /// </summary>
+        /// <returns></returns>
         public (bool isChanged, long stateId, byte[] data) IsChangedWithId()
         {
             var res = stateHash.IsChanged();
@@ -69,6 +83,9 @@ public void BeforeSaveToDB()
             // table.Set(saveState.Key, saveState);
         }
 
+        /// <summary>
+        /// 
+        /// </summary>
         public void AfterSaveToDB()
         {
             stateHash.AfterSaveToDb();

DataBaseServer/GameFrameX.DBServer/State/ICacheState.cs

@@ -1,5 +1,8 @@
 namespace GameFrameX.DBServer.State;
 
+/// <summary>
+/// 缓存数据对象接口
+/// </summary>
 public interface ICacheState : ISafeDelete, ISafeCreate, ISafeUpdate
 {
     /// <summary>
@@ -18,5 +21,8 @@ public interface ICacheState : ISafeDelete, ISafeCreate, ISafeUpdate
     /// <param name="isNew"></param>
     void AfterLoadFromDB(bool isNew);
 
+    /// <summary>
+    /// 
+    /// </summary>
     void AfterSaveToDB();
 }

DataBaseServer/GameFrameX.DBServer/State/InnerState.cs

@@ -1,5 +1,8 @@
 namespace GameFrameX.DBServer.State;
 
+/// <summary>
+/// 
+/// </summary>
 public abstract class InnerState
 {
 }

DataBaseServer/GameFrameX.DBServer/Storage/xxHashExtension.cs

@@ -1,5 +1,8 @@
 namespace GameFrameX.DBServer.Storage;
 
+/// <summary>
+/// XXHash扩展
+/// </summary>
 public static class XxHashExtension
 {
     /// <summary>