Appearance
代码-协议双向同步
目标
确保“改代码必看协议,改协议必看代码”,减少双协议并行维护偏差。
双向同步规则
代码 -> 协议
发生以下改动时,必须同步协议文档:
- 新增/删除指令
- 指令字段增删改(名称、顺序、单位、取值范围)
- 指令时序变化(触发时机、应答策略、超时重试)
协议 -> 代码
发生以下改动时,必须同步嵌入式实现:
- 协议正文字段语义变化
- 默认行为、错误码、状态机流程变化
- 私有协议与开放协议收敛策略调整
变更联动清单(Checklist)
每次改动请逐项勾选:
- [ ] 已识别改动影响私有协议 / 开放协议 / 双协议
- [ ] 已更新
私有协议.md或开放协议.md - [ ] 已更新 协议对比文档
- [ ] 已更新 NCS协议支持矩阵
- [ ] 已完成至少一个真实链路联调验证(登录/心跳/控制)
记录模板
| 日期 | 改动来源 | 改动摘要 | 涉及项目 | 涉及协议 | 关联代码模块 | 验证结果 |
|---|---|---|---|---|---|---|
| 2026-04-20 | 代码改动 | 示例:统一 HEARTBEAT 字段单位 | NCS10/NCS12 | 私有+开放 | application/ business/ | 待验证 |