文档的最佳实践
指导群里的小伙伴做小项目 应用创意:Chrome 共享首页,有两位同学主动领命,分开前后端就开做。结果我发现他们对文档的处理非常幼稚……所以便有了这样一个分享。
我的观点:
- 文档当然要写,但不要用自然语言这样写一大篇
- 文档如果不好好维护,将来表现和实际代码不一致,会造成更大的问题
- 所以开发者应该用更强的方式约束文档和代码,而不是大家主观协作
- 所以我们——尤其在前后端协作的时候——应该写格式化数据结构描述,然后通过编译的方式,用数据结构描述输出文档、测试、Mock Data
下面是视频:
相关文章
E2E 测试用例的一般要求
周会上,聊到我们需要普及自动化 E2E 测试,用自动化 E2E 测试回归降低研发成本。老板问: 测试同学已经准 […]
2022-10-023 分钟
React Native + Expo 入门级实战开发多平台应用 WhiteScreen:3. 深入开发,完成应用主体
感谢剪辑同学的努力工作,第三集上线。 油管地址:https://youtu.be/0Ix-Y-MPQY0 B站 […]
2025-09-272 分钟
【视频教程】React Native + Expo 入门级实战开发多平台应用 WhiteScreen:2. 配置模拟器开发环境+开发Expo应用
感谢剪辑同学的努力工作,第二集终于可以奉献给各位同学。 油管地址:https://youtu.be/YEPvi […]
2025-09-192 分钟


