docs: update core and debug API docs

This commit is contained in:
2026-03-20 02:35:07 +08:00
parent 0c073db4e8
commit e165dbea1c
73 changed files with 743 additions and 391 deletions

View File

@@ -6,87 +6,67 @@
**头文件**: `XCEngine/Debug/Logger.h`
**描述**: 全局日志记录器单例,提供多级别、多分类的日志输出。
**描述**: 日志系统,提供分级日志记录功能
## 概述
`Logger` 是 XCEngine 的核心日志系统单例。它支持多个日志输出目标Sink、日志级别过滤、分类开关,并提供宏方便使用
Logger 是 XCEngine 的核心日志系统采用单例模式设计。它提供多级别Verbose、Debug、Info、Warning、Error、Fatal和多分类General、Rendering、Physics 等)的日志记录功能,支持自定义日志输出Sink
## 单例访问
| 方法 | 描述 |
|------|------|
| `static Logger& Get()` | 获取单例实例 |
Logger 支持多个 Sink 组件,每个 Sink 可以将日志输出到不同的目的地(如文件、控制台、远程服务器等)。系统还提供宏定义 `XE_LOG``XE_ASSERT` 方便快速记录日志。
## 公共方法
| 方法 | 描述 |
|------|------|
| `void Initialize()` | [初始化日志系统](initialize.md) |
| `void Shutdown()` | [关闭日志系统](shutdown.md) |
| `void AddSink(std::unique_ptr<ILogSink> sink)` | [添加日志输出目标](addsink.md) |
| `void RemoveSink(ILogSink* sink)` | [移除日志输出目标](removesink.md) |
| `void Log(...)` | [通用日志记录](log.md) |
| `void Verbose(...)` | [Verbose 级别日志](verbose.md) |
| `void Debug(...)` | [Debug 级别日志](debug.md) |
| `void Info(...)` | [Info 级别日志](info.md) |
| `void Warning(...)` | [Warning 级别日志](warning.md) |
| `void Error(...)` | [Error 级别日志](error.md) |
| `void Fatal(...)` | [Fatal 级别日志](fatal.md) |
| `void SetMinimumLevel(...)` | [设置最小日志级别](setminimumlevel.md) |
| `void SetCategoryEnabled(...)` | [开启/关闭指定分类](setcategoryenabled.md) |
## 宏定义
### XE_LOG
```cpp
#define XE_LOG(category, level, message) \
XCEngine::Debug::Logger::Get().Log(level, category, message, __FILE__, __LINE__, __FUNCTION__)
```
通用日志宏,自动填充文件名、行号和函数名。
### XE_ASSERT
```cpp
#define XE_ASSERT(condition, message) \
if (!(condition)) { \
XCEngine::Debug::Logger::Get().Fatal(XCEngine::Debug::LogCategory::General, message); \
}
```
断言宏,条件失败时记录 Fatal 日志。
| [`Get`](get.md) | 获取 Logger 单例实例 |
| [`Initialize`](initialize.md) | 初始化日志系统 |
| [`Shutdown`](shutdown.md) | 关闭日志系统 |
| [`AddSink`](addsink.md) | 添加日志输出槽 |
| [`RemoveSink`](removesink.md) | 移除日志输出槽 |
| [`Log`](log.md) | 通用日志记录方法 |
| [`Verbose`](verbose.md) | 记录 Verbose 级别日志 |
| [`Debug`](debug.md) | 记录 Debug 级别日志 |
| [`Info`](info.md) | 记录 Info 级别日志 |
| [`Warning`](warning.md) | 记录 Warning 级别日志 |
| [`Error`](error.md) | 记录 Error 级别日志 |
| [`Fatal`](fatal.md) | 记录 Fatal 级别日志 |
| [`SetMinimumLevel`](setminimumlevel.md) | 设置最低日志级别 |
| [`SetCategoryEnabled`](setcategoryenabled.md) | 设置分类日志开关 |
## 使用示例
```cpp
#include <XCEngine/Debug/Logger.h>
#include "XCEngine/Debug/Logger.h"
#include "XCEngine/Debug/ConsoleSink.h"
using namespace XCEngine::Debug;
// 获取单例
Logger& logger = Logger::Get();
// 初始化
Logger::Get().Initialize();
Logger::Get().AddSink(std::make_unique<ConsoleLogSink>());
Logger::Get().AddSink(std::make_unique<FileLogSink>("app.log"));
logger.Initialize();
// 设置日志级别
Logger::Get().SetMinimumLevel(LogLevel::Debug);
// 添加控制台输出Sink
logger.AddSink(std::make_unique<ConsoleSink>());
// 使用便捷方法
Logger::Get().Info(LogCategory::Rendering, "Render started");
Logger::Get().Warning(LogCategory::Memory, "High memory usage");
Logger::Get().Error(LogCategory::FileSystem, "Failed to load file");
// 使用便捷方法记录日志
logger.Info(LogCategory::General, "Application started");
logger.Warning(LogCategory::Rendering, "Low memory warning");
logger.Error(LogCategory::Network, "Connection failed");
// 使用宏(自动带位置信息)
XE_LOG(LogCategory::General, LogLevel::Info, "Application initialized");
// 使用宏记录日志(自动包含文件、行号、函数信息)
XE_LOG(LogCategory::General, LogLevel::Info, "User logged in");
// 使用断言
XE_ASSERT(ptr != nullptr, "Pointer must not be null");
// 设置最低日志级别
logger.SetMinimumLevel(LogLevel::Warning); // 只记录 Warning 及以上
// 关闭
logger.Shutdown();
```
## 相关文档
- [Debug 模块总览](../debug.md) - 返回模块总览
- [ILogSink](../ilogsink/ilogsink.md) - 日志输出接口
- [ConsoleLogSink](../consolelogsink/consolelogsink.md) - 控制台输出
- [FileLogSink](../filelogsink/filelogsink.md) - 文件输出
- [LogLevel](../loglevel/loglevel.md) - 日志级别枚举
- [LogCategory](../logcategory/logcategory.md) - 日志分类枚举
- [ILogSink](../ilogsink/ilogsink.md) - 日志输出槽接口