90 lines
1.2 KiB
Markdown
90 lines
1.2 KiB
Markdown
|
<!--
|
|||
|
|
模块：api（API 文档）
|
|||
|
|
用途：详细的接口说明
|
|||
|
|
位置：库项目的核心章节
|
|||
|
|
-->
|
|||
|
|
|
|||
|
|
## API 文档
|
|||
|
|
|
|||
|
|
### 概览
|
|||
|
|
|
|||
|
|
{{API_OVERVIEW}}
|
|||
|
|
|
|||
|
|
### 核心 API
|
|||
|
|
|
|||
|
|
#### `{{FUNCTION_1_NAME}}`
|
|||
|
|
|
|||
|
|
{{FUNCTION_1_DESCRIPTION}}
|
|||
|
|
|
|||
|
|
**签名**：
|
|||
|
|
|
|||
|
|
```{{LANGUAGE}}
|
|||
|
|
{{FUNCTION_1_SIGNATURE}}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
**参数**：
|
|||
|
|
|
|||
|
|
| 参数 | 类型 | 必需 | 说明 |
|
|||
|
|
|------|------|------|------|
|
|||
|
|
{{FUNCTION_1_PARAMS}}
|
|||
|
|
|
|||
|
|
**返回值**：
|
|||
|
|
|
|||
|
|
{{FUNCTION_1_RETURN}}
|
|||
|
|
|
|||
|
|
**示例**：
|
|||
|
|
|
|||
|
|
```{{LANGUAGE}}
|
|||
|
|
{{FUNCTION_1_EXAMPLE}}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
#### `{{FUNCTION_2_NAME}}`
|
|||
|
|
|
|||
|
|
{{FUNCTION_2_DESCRIPTION}}
|
|||
|
|
|
|||
|
|
**签名**：
|
|||
|
|
|
|||
|
|
```{{LANGUAGE}}
|
|||
|
|
{{FUNCTION_2_SIGNATURE}}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
**参数**：
|
|||
|
|
|
|||
|
|
| 参数 | 类型 | 必需 | 说明 |
|
|||
|
|
|------|------|------|------|
|
|||
|
|
{{FUNCTION_2_PARAMS}}
|
|||
|
|
|
|||
|
|
**返回值**：
|
|||
|
|
|
|||
|
|
{{FUNCTION_2_RETURN}}
|
|||
|
|
|
|||
|
|
### 类型定义
|
|||
|
|
|
|||
|
|
```{{LANGUAGE}}
|
|||
|
|
{{TYPE_DEFINITIONS}}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 常量
|
|||
|
|
|
|||
|
|
| 常量 | 值 | 说明 |
|
|||
|
|
|------|-----|------|
|
|||
|
|
{{CONSTANTS_TABLE}}
|
|||
|
|
|
|||
|
|
### 错误处理
|
|||
|
|
|
|||
|
|
| 错误码 | 说明 | 处理建议 |
|
|||
|
|
|--------|------|----------|
|
|||
|
|
{{ERRORS_TABLE}}
|
|||
|
|
|
|||
|
|
### 完整 API 参考
|
|||
|
|
|
|||
|
|
详细的 API 文档请查看 [API Reference]({{API_REFERENCE_URL}})。
|
|||
|
|
|
|||
|
|
<!--
|
|||
|
|
编写提示：
|
|||
|
|
- 每个函数都有签名、参数、返回值、示例
|
|||
|
|
- 类型定义要完整
|
|||
|
|
- 说明错误处理方式
|
|||
|
|
- 保持格式统一
|
|||
|
|
-->
|