Java编程规范

1.If for while等语句的执行语句不管有多少都要加上{}

2.相对独立的程序块之间,必须要有空行。

public void fun(int i) {
    System.out.println(i);
}

int index;

3.对齐只使用空格键不使用TAB键(因为不同编辑器tab键空格数可能不同)

4.在两个以上的关键字、变量、常量进行对等操作时,他们之间的操作符之前、之后度需要加空格。

img

img

5.将注释与其上面的代码用空行隔开

img

6.对变量的定义和分支语句(条件分支、循环语句等)必须添加注释。

7.边写代码边注释,修改代码的同时修改相应的注释,以保证注释与代码的一致性。没用的注释要删掉。

8.避免在注释中使用缩写,使用缩写时,应对缩写进行必要的说明。

9.属性名和方法名不能相同,都使用驼峰格式,且方法名最好使用动宾结构,或动词。

10.常量名使用全大写,英文单词之间使用下划线分开

11.含有集合意义的属性名,尽量包含其复数的意义。

12.所有的数据类必须重载toString()方法,返回该类有意义的内容。

13.明确方法功能,精确地实现方法设计,一个函数仅仅完成一个功能,即使简单的功能也应该另写方法实现。这样可以增加程序的可读性。

14.明确类的功能,精确地实现类的设计。一个类仅实现一组相近的功能 。(说明:划分类的时候,应尽量把逻辑处理、数据和显示分离,实现类功能的单一性。)
数据类不包含数据处理逻辑; 通信类不包含显示处理的逻辑。

15.异常捕获后,如果不对该异常进行处理,则应记录日志。

16.自己抛出的异常必须填写详细的描述信息。

17.避免使用不易理解的数字,用有意义的标识来替代。涉及物理状态或者含有物理意义的常量,不应该直接使用数字,必须用有意义的静态变量来代替。

18.数组声明的时候使用int[] array, 而不要使用int array[].可读性问题

19.调试代码的时候,不要使用system.out或system.err进行打印,应该使用一个包含统一开关的测试类进行统一打印。
说明:代码发布的时候可以统一关闭调试代码,定位问题的时候又可以打开开关。

20.记录异常不要保存exception.getMessage(),而要记录exception.toString()。

21.一个方法不应该抛出太多类型的异常

说明:如果程序中需要分类处理,则将异常根据分类组织成继承关系。如果确实有很多异常类型首先考虑异常描述来区别,throws/exception子句标明的异常最好不要超过三个。

22.异常捕获尽量不要直接catch(Exception e),应该把异常细分处理

23.如果多段代码重复做同一件事情,那么在方法的划分上可能存在问题。

说明:若此段代码各语句之间有实质性关联并且是完成同一个功能的,那么可以考虑把此段代码造成一个新的方法。

24.把main()方法放到类的最后,声明方法违例的时候不要使用Exception,应该使用他的子类。

25.不要直接扔出一个Error,应该扔出它的子类。

26.尽量不要使用内部类

27.一个sql语句使用到多张表时要记着使用别名,字段要记住用表名调用如下

user.password

28.Import不要使用通配符:不要出现类似这样的import语句:import java.util.*;

29.类的排序

类的成员顺序对易学性有很大的影响,但这也不存在唯一的通用法则。不同的类对成员的排序可能是不同的。 最重要的一点,每个类应该以某种逻辑去排序它的成员,维护者应该要能解释这种排序逻辑。比如, 新的方法不能总是习惯性地添加到类的结尾,因为这样就是按时间顺序而非某种逻辑来排序的。
当一个类有多个构造函数,或是多个同名方法,这些函数/方法应该按顺序出现在一起,中间不要放进其它函数/方法。

30.每次之声明一个变量:不要使用组合声明,比如int a, b;。

31.中括号是类型的一部分:String[] args, 而非String args[]。

32.花括号前空一格,条件语句if while后有空格

33.Static在final前面

发布了142 篇原创文章 · 获赞 105 · 访问量 87万+
展开阅读全文

没有更多推荐了,返回首页

©️2019 CSDN 皮肤主题: 大白 设计师: CSDN官方博客

分享到微信朋友圈

×

扫一扫,手机浏览