函数说明
1. 说明范围
这里只记录“稳定可调用”的函数入口,不记录私有 helper。
包括:
- CLI 命令入口
- 稳定脚本入口
- 插件 Hook
- 对外暴露的函数或服务调用点
2. 每个函数入口至少说明
- 名称
- 作用
- 参数
- 返回结果
- 失败语义
- 副作用
- 示例
- 版本与兼容约束
3. 变更要求
以下变化必须同步更新本页和相关接口文档:
- 参数变化
- 返回值变化
- 错误语义变化
- 权限和鉴权变化
- 幂等、超时、重试变化
这里只记录“稳定可调用”的函数入口,不记录私有 helper。
包括:
以下变化必须同步更新本页和相关接口文档: