给JAVA设计开发新手的一些建议和意见(1)(1)

中华网科技 http://tech.china.com 2005-08-01 14:55:40

【进入BBS】【进入聊天室】【 推荐给朋友 】【浏览字号：大 中 小】【关闭窗口】

　　为了给朋友同事一些设计问题上的指导，特撰写此文，很多观点都是从别人的文章中获取，有些观点肯定也有偏颇，有些观点也仅仅是提出并没有做详细论述，请多拍砖，以便改正。

　　【概述】
　　-------
　　在工作中，作为一个程序员或者一个设计师，总是要设计一些函数库或者一个框架，当然最经常的还是做项目，即使是一个项目，也会被经常改动，甚至交给别人改动。
　　当你做这些工作的时候，你的这些成果都是要给别人了解使用的，或者说给以后的你使用的，为了别人的方便或者为了自己的方便，我们要尽可能做好设计。
　　

　　【放正心态，任何东西都是不断发展的】
　　----------------------------------

　　技术是日新月异的，每一天都有新的技术出来，正所谓"山外有山，人外有人"，每一个新的轮子出来，都可能比你要设计的轮子好，所以在设计的时候，应该了解一下是否已经有了类似的轮子，是否要设计一个新的轮子。

　　即使你的轮子已经设计好了，也不好认为自己的轮子一定比别人的轮子好，虽然你的轮子可能更适合你的实际使用。

　　技术在不断的发展中，你以及你的朋友/同事都在不断进步，"士别三日，当刮目相看"，所以不要认为你的水平一定比别人高，"尺有所短，寸有所长"，所以别人对你的函数库/框架提出意见，提出疑问的时候，请不要惊奇，不要反感，不要认为别人在"挑刺"，也许你的函数库/框架早就不适合当前的发展了。
　　
　　
　　态度决定一切。你的领导或许更重视这一点。
　　
　　
　　【必要的组成部分:单元测试，文档，实例，手册etc】
　　--------------------------------------------

　　单元测试，文档，API Doc，手册，演示程序，Change Log，Readme，build。xml等等

　　有一天别人使用了你设计的函数库/框架，当你升级后，原来的项目却不能工作了，经过一天的调试，你终于找到了原因，原来是不小心写错了一个东西。

　　你肯定不希望上述的事情发生，那么请你写单元测试吧，这样既不浪费自己的时间，也不耽误别人的工作，何乐而不为。你花在写单元测试的时间/带来的乐趣和你升级后改正莫名其妙的错误的时间和苦恼相比，肯定更有价值。你看到单元测试的绿条，难道不感到高兴吗?!

　　如果你不能保证你的程序修改没有错误，不要指望你的同事认为你的错误是可以容忍的，他们在心里早就开始骂你了，呵呵。写单元测试吧
　　
　　看看任何一个知名的框架，都包含完善的文档，单元测试，示例程序，用户手册，那么请你也包含这些吧。哦，对了，请详细地写好JavaDoc，它很重要。
　　
　　使用你的框架/函数库的人如果到处去找使用方法，去找某个类(但是他不知道是否有这个类)，那么说明你的文档没有到位。如果你希望别人使用你的这个类或者功能，那么请写好文档，不要指望别人去读你的源码然后就能理解它是干什么用的。
　　
　　如果你做到这些，那么你的函数库/框架也有了"知名"的前提，难道不是吗?如果没有，我想是没法让别人更好地使用的。
　　
　　对了，有了这些东西，还要有一个良好的目录组织，这个也可以参考别的框架的组织方式。

首页 上页 | 1 | 2 | 3 | 4... 下页 尾页  共 4 页