Skip to content

Commit 677d17c

Browse files
committed
docs(Hotfix/Agent): 完善基础组件代理类的日志记录器文档
补充 InitLogger 和 GetLogger 方法的 XML 文档注释,说明其用途和行为
1 parent abf0da1 commit 677d17c

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

GameFrameX.Core/Hotfix/Agent/BaseComponentAgent.Logger.cs

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,20 +38,31 @@ namespace GameFrameX.Core.Hotfix.Agent;
3838
/// <summary>
3939
/// 基础组件代理类,用于管理组件与Actor之间的交互
4040
/// </summary>
41-
/// <typeparam name="TComponent">具体的组件类型</typeparam>
4241
public abstract partial class BaseComponentAgent<TComponent> where TComponent : BaseComponent
4342
{
4443
private ILogger _logger;
4544

4645
/// <summary>
47-
///
46+
/// 初始化日志记录器
4847
/// </summary>
49-
/// <returns></returns>
48+
/// <returns>返回自定义的日志记录器实例,如果返回 null 或 default,则使用默认的 Serilog 全局日志记录器</returns>
49+
/// <remarks>
50+
/// 子类可以重写此方法来提供自定义的日志记录器配置,
51+
/// 例如设置特定的日志级别、输出格式或目标位置
52+
/// </remarks>
5053
protected virtual ILogger InitLogger()
5154
{
5255
return default;
5356
}
5457

58+
/// <summary>
59+
/// 获取日志记录器实例
60+
/// </summary>
61+
/// <returns>返回可用的日志记录器实例</returns>
62+
/// <remarks>
63+
/// 使用延迟初始化模式,首次调用时会通过 InitLogger() 方法创建日志记录器,
64+
/// 如果 InitLogger() 返回 null,则使用 Serilog 的全局静态日志记录器作为后备方案
65+
/// </remarks>
5566
private ILogger GetLogger()
5667
{
5768
if (_logger == default)

0 commit comments

Comments
 (0)