面向对象开发的一点心得 - 文档

面向对象的软件开发是目前计算机软件开发的主流，其设计思想和原则虽然简单，但是如何应用好这些思想和原则却是需要在长期的实践中不断体会和提高。本人虽然从事了长达10年的软件开发，但是说来惭愧，每次看到自己的代码，总是觉得欠缺多多。

使用面向对象的方法设计软件，如果结构设计的好，则软件易于扩展，但是如果软件规模较大的话，对于代码的阅读和维护会带来一定的困难。譬如对于工厂模式，在同一个父类下有若干个实现不同功能的子类，在具体应用的地方根据实际需要创建并调用相应的子类，这样的方式使得程序易于维护和扩展，因为实现新的功能只需要增加一个新的子类就可以了。

但是在系统的调试过程中，如果发现有问题，经常会花费大量的时间在确定到底是哪一个子类出了问题，或者经常会回去看使用的是哪一个设计模式，代码应该如何扩展才会符合原有的设计模式。为了节省在这方面的时间，往往还需要编写技术文档，对各个对象进行说明，强调每类对象是如何扩展的。

根据XP编程的要求，所有的一切都是通过代码来说明，我也是按照这个要求编写了几个软件，但是在实践中发现，只有代码，没有文档说明，我在调试程序的时候经常会被程序的结构搞乱，不得不回去再次确认程序的结构，确定哪一些功能应该在哪些对象中实现。事实上，编写程序没有花费太多的时间，调试的时候却花了不少时间。

另外在程序扩展，增加新功能的时候，往往需要重新回去阅读代码，确定原来的程序构架，以便将新的功能采用正确的方式添加进去。

所以，我认为在编写程序的时候——即便是采用XP编程——还是应该有必要的文档留下来，尤其是系统的构架和设计，类的UML图，各个类之间的关系，类的扩展点等内容，把这些写成文档，可以作为程序的规范，这样以后在维护和扩展的时候，就不会破坏原来的结构，增加代码的“臭味”，也不需要花费大量的时间阅读原来的代码重新了解程序构架了。

文档说明不需要包括函数说明等细节，这些完全可以在代码中写注释，通过文档工具自动生成即可。

我不是大师，我相信大多数的程序员也和我一样，没有大师那么犀利的能力，所以最好的方法还是编写文档，把自己的设计思想全部保留下来。如果在间隔几个月以后忽然领导要求去维护一下以前的某个程序，我相信你一定会庆幸因为文档的存在，而不需要重新阅读浩如烟海的代码，苦苦寻找下手的地点了。