浅谈Java开发规范--命名规范

    一个好的软件,不单依赖于架构及项目管理,而且与代码质量也息息相关。代码质量取决于代码的整洁度,整洁的代码在软件维护期、软件升级过程中奠定了良好的基础，如何才能写出高质量代码呢?高质量代码好有很多方面的因数,命名规范是高质量代码的开端也是一个重点,下面是我个人的一些见解，欢迎大家多多指教.  

     1.命名尽量做到名副其实。

     很多人看到这个都说很简单,这个问题一点都不简单,好的方法、函数、变量、类的名称已经答复使用者这个函数功能、如何使用等,如果需要注释说明就说明你没有做到名副其实,在软件开发过程中做到这点是非常困难的,这个需要经验的不断积累和总结以及团队之间的融合,一旦发现有的好的命名就替换掉旧的,这在软件维护期会给你或阅读你代码的人带来意想不到的惊喜。

      例如:一个变量功能都一致,表示用户账号,你看到：

String str="wilr"; //用户  

      舒服,还是看到:

String account="wilr"; 

     舒服呢?我想大家都不言而喻吧。这只是一个小小的例子,可能还不足够说明问题,但是我相信看到这个小例子,大家都会明白以上所说的,所以我就不再举例说明了。

  2.避免不必要的错误

    在软件开发过程中,特别是大项目中,会存在很多的变量、方法、以及类,如果名称相似,会导致一些看起来莫名其妙但是非常幼稚的错误,这种错误本应该不存在的,这种错误也会给代码维护、调试带来不必要的工作量:

    例如:

     1.userPersistent和usersPersistent, userPersistent表示用户持久化,usersPersistent表示用户组持久化层,这2个持久化类,在开发过程中调用错误的几率是不是非常大呢?这种错误会不会让你觉得莫名奇妙呢?

   3.命名区分

   开发过程中,我们新建或者@Override一个方法的时候,编辑器会帮我们写了一部分代码,这些代码一般都是没有意义的,区分不明显的,如C1、C2......看段代码你就会明白我想表达的意思了,例如:

public void copyString(String str[],String str1[]){
		for (int i = 0; i <str.length; i++) {
			str1[i]=str[i];
		}
	}

    代码中的str[]和str1[],这种区分你是否经常碰到呢?如果我这样修改是不是看起来比较舒服了呢:

public void copyString(String source[],String target[]){
        for (int i = 0; i <source.length; i++) {
		target[i]=source[i];
	 }
  }

    高质量的代码是我们不断的追求,但切记不可一味的追求高质量,因为在实际开发中有一些问题是我们无法避免的,不要为了一个函数、类的名称纠结很久很久耽误了工期,耽误工期的后果大家都懂的,在实际开发中要学会灵活变通,不断的积累不断的修改,会写出高质量代码的。

   好了,由于时间关系,先写到这里,有空有想法再继续。如果你有好的想法或者建议,欢迎留言。谢谢！

       

评论

1 楼 shuangpan.zhang 2011-10-21  

同感~~希望大家都能注意到吧!