学习编程,建立一个可行可操作的编程标准,以规范我们的代码开发工作。提高代码的可读性,提高系统的健壮性、稳定性、可靠性,便于自己读懂自己写的代码和后期维护自己的代码。在团队中代码的一致性,可以让软件开发效率明显提高。软件就像一个孩子,而它未来的模样和高度完完全全掌握在我们程序猿的手里,因为我们创造的一行一行有意义的代码便是它的血液。

一、Java编程命名规范

命名时应始终采用完整的英文描述符。此外,一般应采用小写字母,但类名、接口名以及任何非初始单词的第一个字母要大写。

1、使用可以准确说明变量/字段/类的完整的英文描述符。

例如,采用类似 totalgrandTotal 或 DepartmentController这样的名字。虽然象 a1b1 或 dc 这样的名字很简短,输入起来容易,但是我们难以知道它们代表什么含义,因而使代码以理解、维护和改进。

2、采用大小写混合,提高名字的可读性。一般应该采用小写字母,但是类和接口的名字的首字母,以及任何中间单词的首字母应该大写。

3、尽量少用缩写,但如果需要使用,可以选择单词的头4个字母作为缩写。

如:DeptInfoValueMapActi, MapActiInst 等等。

4、避免使用长名字(最好不超过 15 个字母)。 虽然 PhysicalOrVirtualProductOrService 看起来似乎是个不错的类名,但是这个名字太长了,应该考虑重新给它起个短一点的名字,比如 Offering

5、避免使用相似或者仅在大小写上有区别的名字。

例如,不应同时使用变量名 persistentObject 和 persistentObjects,以及 anSqlDatabase 和 anSQLDatabase

6、避免使用下划线作为名字的首末字母。以下划线为首末字母的名字通常为系统保留,除预处理定义之外,一般不用作用户命名。更重要的是,下划线经常造成麻烦而且难输入,所以尽量避免使用。

7、包的命名:小写的英文字母组成,每个包名称之间用点号分隔开来;全局包的名字用所在机构的网站保留域名开头。

如:com.sun   com.oracle 等。

8、类的命名:采用完整的英文描述符,所有单词的第一个字母要大写,并且单词中大小写混合,并且类名应是单数形式。

9、接口的命名:采用完整的英文描述符,所有单词的第一个字母大写。习惯上,名字后面加上后缀 able, ible 或者 er。

 

二、Java编程格式规范

1、花括号{}能用则用,不需要省,还有需要注意换行,这样比较容易理解和美观

例如:

if(int a > 0){
      ...;
}else{
      ...;
}

2、用switch语句应该都带有一个default,当出现了意料之外的情况时可以在default中抛出异常。 

三、其他

1、用equals时,应该把要判断的值放在后面,equals前面一定确保放的不是空的(null),因为当equals前面的值为空的时候,就会报错,无法继续持续程序。

2、给代码加上注释,但是如果你的代码不值得注释,那么它就不值得保留 。当正确地使用了本文提到的注释标准和方针,就可以大幅度地提高代码质量。

3、让代码分段/缩进,一种提高代码可读性的方法是给代码分段,换句话说,就是在代码块内让代码缩进。所有在括号 { 和 } 之内的代码,构成一个块。基本思想是,块内的代码都应统一地缩进去一个单位。在代码中使用空白。在 Java 代码中加入几个空行,也叫空白,将代码分为一些小的、容易理解的部分,可以使它更加可读。建议采用一个空行来分隔代码的逻辑组,例如控制结构,采用两个空行来分隔成员函数定义。没有空白的代码很难读,很难理解。

4、需要保证其他的程序员应能在少于 30 秒钟的时间内完全理解你的成员函数,理解它做什么,为什么这样做,它是怎样做的。如果他们做不到,说明你的代码太难维护,应加以改进。30 秒钟,明明白白。 一个好的经验法则是:如果一个成员函数一个屏幕装不下,那么它就很可能太长了。

5、写短小单独的命令行,每一行代码只做一件事情。我们应使代码尽量容易理解,从而更容易维护和改进。正如同一个成员函数应该并且只能做一件事一样,一行代码也只应做一件事情。此外,应让代码在一个屏幕内可见。 也不应向右滚动编辑窗口来读取一整行代码,包括含有行内注释语句的代码。