@realsee/five
Version:
Realsee Renderer SDK
82 lines (50 loc) • 2.16 kB
Markdown
# 功能名称 (中文名称)
- **Summary**: 一段一句话的概要(中文)。
- **Schema**: 简述涉及的数据结构或类型。
- **Concepts**: 涉及的核心概念关键词。
- **Configuration**: 关键配置项说明。
- **Examples**: 简述提供的示例类型。
## Schema
<!--
⚠️ AI 注意:以下 Definition 链接使用了反引号包裹(代码块格式),这是模板的占位符写法,
目的是避免构建时因路径不存在而报错。
在编写正式文档时,必须将其还原为标准 Markdown 链接(去掉反引号),并确保路径指向真实存在的 .ts 文件。
-->
> **Definition**: `[InterfaceName](../../five/path/to/source.d.ts)` 或多个 `[Main](../../lib/...)`, `[Options](../../lib/...)`
(这里放置 Interface 定义、TS 类型或参数表。务必包含 Definition 源码链接。)
## Concepts
(这里解释核心概念、术语定义及业务逻辑)
## Configuration
(可选:初始化参数、配置项说明。若参数较多,请按以下分类展示)
### Common Configuration (常用配置)
| Parameter | Type | Default | Description |
| :--- | :--- | :--- | :--- |
| `key` | `type` | `default` | Description. |
### Advanced Configuration (进阶配置)
| Parameter | Type | Default | Description |
| :--- | :--- | :--- | :--- |
| `key` | `type` | `default` | Description. |
## Instance Properties
(可选:类文档专用,列出关键属性及类型)
## Instance Methods
(可选:类文档专用,列出关键方法签名及说明)
## Examples
### 快速上手 (Quick Example)
(最小可运行代码)
### 进阶用法 (Advanced Usage)
(更复杂的场景或配置)
## Debugging
(可选:调试技巧、监控方法)
## Common Pitfalls
1. **坑点1**: 说明及规避方法。
2. **坑点2**: ...
## Related
<!--
⚠️ AI 注意:以下链接同样使用了反引号包裹(占位符写法)。
在编写正式文档时,必须还原为可点击的标准 Markdown 链接,并确保路径指向真实存在的文件。
-->
* `[RelatedConcept](./related-concept.md)`: 简述关联关系。
---
```yaml
tags: [keywords, tags]
```