文档不能像“写完了就扔一边”的作业,得跟着代码一起更新!
为什么? 代码改了,文档没改 → 文档就废了,看文档的人会被坑(比如API接口变了但文档没更新,开发者调不通只能硬啃源码)。 正确操作:把文档当代码一样维护,代码更新时顺手改文档(比如GitHub上用Markdown写文档,和代码放一起)。