ARTS - Share

养成写开发文档习惯

一个优秀程序员应该把80%时间用来写文档，20%的时间用于编码。

为什么写文档？

文档，就像盖楼房的设计图，没有图纸，你是不能开始搬砖的。

写什么文档？

要干什么？要干成什么样？

领导有没有给你看需求分析文档？有没有拿着需求分析文档给你宣讲你要做什么？没有？不干活；

测试的同事有没有给你看测试用例文档？有没有给你宣讲？没有？不干活；

你自己明白领导的意图了吗？明白测试同事的意图了吗？

大处着眼小处着手

想明白后，开始想自己要开发的模块里的各个功能模块之间的关系，可以画时序图；

时序图画完了，看看是否有（可能）频繁变化的模块/需求，如果有，请务必使用一些设计模式，

如果要用设计模式，请务必画UML类图，如果没有频繁变化的模块/需求，请一定不要用设计模式；

最后，看看在一个功能模块中，有没有逻辑比较复杂的地方，如果有，请画流程图；

模块和模块之间有没有需要明确的协议？如果有，请把协议写出来。

主要是自己读

上面这一段话，就是你要写的文档，这个文档的读者主要是你，在你的模块出问题之前，别人通常不会读这个文档（不排除你的领导会要求看你这个文档）。

如果你既不需要时序图又不需要类图又没什么协议需要明确，那么，你就可以不写这个文档。另外，如果这个文档写得好，你的代码是不需要任何注释的。