LibMCPP API 文档

文档标准格式

所有 docs/api/ 下的 API 文档必须遵循此模板。新文档以此为准，旧文档逐步对齐。

C++ API 文档模板

# 模块名

> **头文件**: `<mc/xxx.h>`
> **命名空间**: `mc::xxx`

## 概述
一句话说明模块做什么，适用什么场景。

## 主要特性
- 特性1
- 特性2
- ...

## 基本用法
≥3 个完整可编译的代码示例。每个示例必须包含 `#include` 和 `main()`。

## API 详细说明

### 类名
| 方法 | 参数 | 返回值 | 异常 | 线程安全 | 说明 |
|------|------|--------|------|----------|------|
| `method` | `param` - 说明 | `ReturnType` | 抛 `mc::xxx_exception` | 是/否 | 说明 |

### 自由函数
```cpp
// 头文件: <mc/xxx.h>
ReturnType function_name(ParamType param);

参数	说明

最佳实践

✅ 正例

// 正确用法

❌ 反例

// 错误用法

≥2 个正例 + ≥2 个反例。

注意事项

• 内存管理注意点
• 线程安全边界
• 性能考虑

相关文档

• 相关模块

### Lua API 文档模板

```markdown
# 模块名 Lua API

> **模块**: `local xxx = require("xxx")`

## 概述
一句话说明。

## 主要特性
- 特性1
- ...

## 基本用法
≥2 个完整可运行的 Lua 代码示例。

## API 详细说明

### function_name
```lua
result = module.function_name(param1, param2)

参数:

参数	类型	说明

返回值:

返回值	类型	说明

异常: 抛什么异常

示例:

-- 用法示例

（每个函数一个 ### 小节，按上述格式展开）

最佳实践

✅ 正例 / ### ❌ 反例

≥2 正例 + ≥2 反例。

相关文档

• 相关模块