在组件目录下的 README.md 文件里编写组件文档, 文档的大概格式如下:

# 组件名称

## 主要功能

1. 有 xx 功能
2. 有 yy 功能

## 可用变量
### 变量名
- 【类型】变量类型
- 【说明】该变量的作用
- 【示例】变量具体的一个取值


## 可用事件
### 事件名
- 【事件 ID】事件ID
- 【触发时机】触发时机


## 编程API (如果有的话)
### API 名字
- 【说明】API 作用说明
- 【参数: xxx】xxx说明
- 【参数: yyy】yyy说明
- 【返回值】API的返回值

## 其他注意事项 (如果有的话)

其中 可用变量 和 可用事件 就是配置器的 getSupportedVariableListgetSupportedEventList 返回的内容, 下面以评论组件为例:

# 评论组件

## 主要功能

1. 展示评论列表
2. 添加评论


## 可用变量
### CONTENT
- 【类型】string
- 【说明】评论内容
- 【示例】"abc"


## 可用事件
### 添加评论
- 【事件 ID】onAddComment
- 【触发时机】点击添加评论按钮

如有其他需要补充的也可以写在这里。

results matching ""

    No results matching ""