最近阅读 C++代码的感想

 

一个优秀的C++程序员通过运用派生、虚函数、重载、序列化等一系列技巧把代码写得非常抽象。这样的代码非常精巧，对事物的描述也非常到位。通过一定抽象，代码也可以非常简洁。但是如果没有足够的文档和介绍，对接手维护这个系统的人无疑是一个噩梦。

最近我看的一个系统代码就是设计比较好，可惜阅读起来比较难懂。特别是其中重载符号运算符，并且与我们通常对，加号等符号理解不一致的时候，特别难以理解。最好花了一番功夫，通过阅读相关文档，终于对代码有了比较清晰的稳定。

通过这个系统的阅读，认为一个较大的C++程序，需要的文档应该有以下几个方面：

 

（1）有一个程序结构图（类图），介绍系统的框架； （可以使用工具来生成）

（2）有一个数据流程图，介绍程序的流程，或者一系列的UML图。不过画UML图比较耗时间，有一个流程图就不错了。

（3）需求文档，介绍相关的业务知识。设计文档，搞清楚设计者的思路。记录设计者设计的时候考虑了那些因素。特别要 记录系统中对特殊情况的处理。

（4）部署文档，包括相关程序，数据的部署情况。

 

 

ps:可以使用doxygen 创建代码文档

一个月专心的学习室必要的。