refactor: 优化代码注释和文档字符串格式

style: 统一代码风格和格式

docs: 完善函数和方法的文档字符串

refactor(base_model): 移除冗余的表名和表参数生成方法

refactor(constant): 更新返回码注释格式

refactor(router_class): 添加路由处理器的详细文档

refactor(database): 完善数据库连接函数的文档

refactor(security): 添加认证类和方法的详细文档

refactor(validator): 更新验证器函数的文档格式

refactor(serialize): 优化序列化工具类的文档

refactor(response): 完善响应类的文档字符串

refactor(dependencies): 添加依赖函数的详细文档

refactor(initialize): 完善初始化脚本的文档

refactor(plugin): 添加生命周期和中间件注册的文档

refactor(service): 完善服务层方法的文档

refactor(controller): 添加控制器方法的详细文档

refactor(crud): 完善CRUD操作的文档字符串

refactor(schema): 简化模型类并移除冗余字段

refactor(param): 更新查询参数类的注释格式

refactor(template): 优化代码生成模板的格式

refactor(console): 添加控制台输出功能的实现

refactor(util): 完善工具函数的文档字符串

backend/app/api/v1/module_monitor/online/controller.py

@@ -28,7 +28,17 @@ async def get_online_list_controller(
     paging_query: PaginationQueryParam = Depends(),
     search: OnlineQueryParam = Depends()
 )->JSONResponse:
-    # 获取全量数据
+    """
+    获取在线用户列表
+    
+    参数:
+    - redis (Redis): Redis异步客户端实例。
+    - paging_query (PaginationQueryParam): 分页查询参数模型。
+    - search (OnlineQueryParam): 查询参数模型。
+    
+    返回:
+    - JSONResponse: 包含在线用户列表的JSON响应。
+    """
     result_dict_list = await OnlineService.get_online_list_service(redis=redis, search=search)
     result_dict = await PaginationService.paginate(data_list= result_dict_list, page_no= paging_query.page_no, page_size = paging_query.page_size)
     logger.info('获取成功')
@@ -46,6 +56,16 @@ async def delete_online_controller(
     session_id: str = Body(..., description="会话编号"),
     redis: Redis = Depends(redis_getter),
 )->JSONResponse:
+    """
+    强制下线指定在线用户
+    
+    参数:
+    - session_id (str): 在线用户会话ID。
+    - redis (Redis): Redis异步客户端实例。
+    
+    返回:
+    - JSONResponse: 包含操作结果的JSON响应。
+    """
     is_ok = await OnlineService.delete_online_service(redis=redis, session_id=session_id)
     if is_ok:
         logger.info("强制下线成功")
@@ -63,6 +83,15 @@ async def delete_online_controller(
 async def clear_online_controller(
     redis: Redis = Depends(redis_getter),
 )->JSONResponse:
+    """
+    清除所有在线用户
+    
+    参数:
+    - redis (Redis): Redis异步客户端实例。
+    
+    返回:
+    - JSONResponse: 包含操作结果的JSON响应。
+    """
     is_ok = await OnlineService.clear_online_service(redis=redis)
     if is_ok:
         logger.info("清除所有在线用户成功")

backend/app/api/v1/module_monitor/online/service.py

@@ -18,6 +18,13 @@ class OnlineService:
     async def get_online_list_service(cls, redis: Redis, search: Optional[OnlineQueryParam] = None) ->  List[Dict]:
         """
         获取在线用户列表信息（支持分页和搜索）
+        
+        参数:
+        - redis (Redis): Redis异步客户端实例。
+        - search (Optional[OnlineQueryParam]): 查询参数模型。
+        
+        返回:
+        - List[Dict]: 在线用户详情字典列表。
         """
 
         keys = await RedisCURD(redis).get_keys(f"{RedisInitKeyConfig.ACCESS_TOKEN.key}:*")
@@ -43,7 +50,16 @@ class OnlineService:
 
     @classmethod
     async def delete_online_service(cls, redis: Redis, session_id: str) -> bool:
-        """强制下线在线用户"""
+        """
+        强制下线指定在线用户
+        
+        参数:
+        - redis (Redis): Redis异步客户端实例。
+        - session_id (str): 在线用户会话ID。
+        
+        返回:
+        - bool: 如果操作成功则返回True，否则返回False。
+        """
         # 删除 token
         await RedisCURD(redis).delete(f"{RedisInitKeyConfig.ACCESS_TOKEN.key}:{session_id}")
         await RedisCURD(redis).delete(f"{RedisInitKeyConfig.REFRESH_TOKEN.key}:{session_id}")
@@ -54,7 +70,15 @@ class OnlineService:
     
     @classmethod
     async def clear_online_service(cls, redis: Redis) -> bool:
-        """强制下线在线用户"""
+        """
+        强制下线所有在线用户
+        
+        参数:
+        - redis (Redis): Redis异步客户端实例。
+        
+        返回:
+        - bool: 如果操作成功则返回True，否则返回False。
+        """
         # 删除 token
         await RedisCURD(redis).clear(f"{RedisInitKeyConfig.ACCESS_TOKEN.key}:*")
         await RedisCURD(redis).clear(f"{RedisInitKeyConfig.REFRESH_TOKEN.key}:*")
@@ -65,7 +89,16 @@ class OnlineService:
     
     @staticmethod
     def _match_search_conditions(online_info: Dict, search: Optional[OnlineQueryParam]) -> bool:
-        """检查是否匹配搜索条件"""
+        """
+        检查是否匹配搜索条件
+        
+        参数:
+        - online_info (Dict): 在线用户信息字典。
+        - search (Optional[OnlineQueryParam]): 查询参数模型。
+        
+        返回:
+        - bool: 如果匹配则返回True，否则返回False。
+        """
         if not search:
             return True