接口相关API文档编写规范

此文档将作为后续 接口相关 API 文档审核规范。

文档结构

1. 需要用简洁的语言描述 API 的相关作用
2. 需要给出 API 类型声明（签名）
3. 需要列出 API 的相关参数，包括参数名称，参数类型，默认值和参数说明
4. 列举 API 返回值的数据结构，需要包括返回值名称、类型、和返回值说明
5. 给出 API 的使用方式代码片段

具体效果可参考useEditingListAPI 文档

总结

日后的日常开发过程中，接口相关 API 文档统一按照此规范编写和校对。