金色坐标

关注互联网和IT科技的个人博客

« Java编码规范二注释规范3G上网能否替代ADSL »

Java编码规范三总结

好消息是,制订一份组织内Java编码规范可以帮助Java开发人员将工作变得更高效。坏消息是,即使有了一份规范,它也并不会自动让你能做到高效开发。为了获得成功,你必须主动地去变得更有效率,也就是说你必须在实际开发中有效地利用这份规范。

如何有效地使用编码规范

1,理解这些规范。花时间去了解为什么每一个规范和准则导致生产力的提高。例如,不要因为规范告诉你要在独立的行中声明局部变量从而这样做,你这样做是因为你知道,它会使你的代码更加可理解。

2,相信规范。理解每一个规范只是一个开始,但你还需要相信它们。遵循这些规范不应该是当你有时间才去做的事情,而应该是你一直在做的事情,因为你认为这是最好的编码方式。

3,在编码时就遵循这些规则,而非在事后。文档注释化的代码无论是在编写过程中还是在编写完后都会更加容易阅读,而命名一致的成员函数和变量则在开发过程中或者在编译运行时都会使开发变得更方便。底线是,遵循这些规则会提高开发效率的同时,也会使得代码变的更加的容易维护。

4,使这些规范成为质量保证的一部分。在对编写的代码进行检查时,应确保代码符合你所在的组织采用的规范。

5,采用那些你最容易理解的规范。你不必一开始就采用全部的规范,而是应该从那些最易于接受或者最难接受的部分开始,逐步的去应用其它的规范。

遵循编码规范外编写成功代码的因素

1,面向用户编码,而不是机器。开发的一个重要目标是使得其他人能看懂你的代码,如果做不到这点,就不是好的代码。尽量遵循命名规范,并书写注释文档。

2,设计在前,编码在后。你是否曾经遇到过一些情况,你开发的代码建立在某些需要改变的代码之上?也许一个新的参数需要传递给一个成员函数,或者某个类需要分成几个不同的类。如果你花时间去思考你将如何编写代码,然后再开始工作,可能你花的时间会更少。

3,小步的前进。我一直认为,小步骤的进行开发,写几个成员函数,然后测试,再写几个函数,再测试,这种开发方式会比一下子写一大堆函数再进行测试并修正其中的bug会有效的多。采取小步骤的渐进式开发,会减少你找到bug的平均时间,进而使得开发的总体时间减少。往大了说这就是敏捷开发。

4,要有阅读和学习的习惯。这个行业发展的太快,每个人都需要投入一定的时间用来不断学习。

5,与用户紧密合作。好的开发人员需要与用户进行紧密合作,因为用户最明白自己的需求。

6,尽量使你的代码看上去简单。复杂的代码书写起来会有成就感,但如果不让别人理解就不是好的代码,事实上一个开发者经常需要在别的程序员的基础上进行开发。

7,尽可能多的了解设计模式、反模式以及术语。目前已经有很多的设计模式、反模式以及术语用来指导开发效率的提高,应该在开发过程中有效地使用适当的设计模式。

常用Java编码规范

项目 包含的内容
访问/修改属性的方法 对所有属性提供访问/修改方法
对于集合类型的变量,提供插入及删除的方法
属性 尽量声明为private
不要直接存取某个属性,用访问/修改方法
不要忘了初始化static变量
在具体编码之前,为类定义一个接口
按照以下顺序声明属性和方法
 构造方法
 finalize()
 public方法
 protected方法
 private方法
 private属性
局部变量 每个变量在独立的行中声明
在紧挨着使用之前声明变量
成员函数 书写javadoc注释
对代码分段
尽量降低此函数的可见度


 




原创文章,如转载请注明:转载自金色坐标 [ http://www.kingxy.com/ ]

本文链接地址:http://www.kingxy.com/archives/179.html

发表评论:

◎欢迎参与讨论,请在这里发表您的看法、交流您的观点。

订阅博客

  • 订阅我的博客:订阅我的博客
  • 关注新浪微博:关注新浪微博
  • 关注腾讯微博:关注腾讯微博
  • 通过Google订阅本站
  • 通过鲜果订阅本站
  • 通过电子邮件订阅
  • 本站支持WAP访问

Search

Google

最新评论及回复

最近发表

金色坐标博客——京ICP备09009094号

本站采用创作共用版权协议, 要求署名、非商业用途和保持一致. 转载本站内容必须也遵循“署名-非商业用途-保持一致”的创作共用协议.
KingXY Blog - This site is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 2.5 License.