07-05 文档与注释:给未来的人留地图
07-05 文档与注释 是软件系统的路标。代码告诉机器怎么做,文档告诉人为什么这么做。
一、它解决什么
它解决的是知识传承问题。人会忘,团队会变,系统会长大。没有文档,后来者只能考古。
二、一个比喻
像城市地图和路牌。路本身存在,但没有地图,外地人很难走。
三、放到系统里看
好文档包括架构图、接口说明、部署步骤、排障手册、设计取舍。注释应解释为什么,而不是重复代码做了什么。
四、常见坑 / 学习抓手
常见坑是文档写完不维护。过期文档比没有文档更危险。
一句话总结
文档是给未来的自己和队友留的路。