2.1.2.2 文档与代码同步更新

文档摘要

2.1.2.2 文档与代码同步更新 2.1.2.2 文档与代码同步更新：用注释驱动的双向校验机制，让文档不再成为“考古现场” 你有没有在凌晨两点，对着一份标着“v2.3.1（最后更新：2022-08-17）”的 API 文档，一边 curl 测试接口，一边反复比对返回字段是否多了一个，一边在 Slack 里问：“这个字段是加了还是删了？谁改的？为什么没同步文档？” 你有没有在 Code Review 时，看到同事提交了一段优雅的 Rust 实现—— ，心里却突然一紧：等等，的 JSON Schema 在 OpenAPI spec 里还写着，但没列这个新字段；Swagger UI 上的示例响应也还是旧的；