• 编程API (如果有的话)
    • API 名字
  • 其他注意事项 (如果有的话)

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

    1. # 组件名称
    3. ## 主要功能
    5. 1. 有 xx 功能
    6. 2. 有 yy 功能
    9. ## 可用变量
    10. ### 变量名
    11. - 【类型】变量类型
    12. - 【说明】该变量的作用
    13. - 【示例】变量具体的一个取值
    16. ## 可用事件
    17. ### 事件名
    18. - 【事件 ID】事件ID
    19. - 【触发时机】触发时机

    编程API (如果有的话)

    API 名字

    • 【说明】API 作用说明
    • 【参数: xxx】xxx说明
    • 【参数: yyy】yyy说明
    • 【返回值】API的返回值

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

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

    1. # 评论组件
    3. ## 主要功能
    5. 1. 展示评论列表
    6. 2. 添加评论
    9. ## 可用变量
    10. ### CONTENT
    11. - 【类型】string
    12. - 【说明】评论内容
    13. - 【示例】"abc"
    16. ## 可用事件
    17. ### 添加评论
    18. - 【事件 ID】onAddComment
    19. - 【触发时机】点击添加评论按钮

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