Rumah  >  Artikel  >  Java  >  java代码编码规范

java代码编码规范

伊谢尔伦
伊谢尔伦asal
2016-11-30 09:51:041015semak imbas

规范需要平时编码过程中注意,是一个慢慢养成的好习惯

1.基本原则

   强制性原则:
     1.字符串的拼加操作,必须使用StringBuilder;
     2.try…catch的用法

try{
}catch{Exception e
    e.printStackTrace();
}finally{
}//在最外层的Action中可以使用,其它地方一律禁止使用;
try{ //程序代码 }catch(Exception e){ //为空,什么都不写 }//在任何场景中都禁止使用
try{
}catch{Exception e throw new runtimeException(e);//最优先采用的写法 }finally{
}

 1.对于捕获后,不知道干什么事情或者也不知道怎样处理的情况,就不要捕获异常,留给外出层去捕获处理;
     2.返回类型为集合的,在方法声明中必须使用泛型,必须在javadoc中注明什么情况下返回null,什么情况下返回空集合。
     3.对于方法、变量声明范围要采用如下优先级:private、protected、public,对于变量要采用如下的优先级:局部变量、实例变量、类变量,如果必须要采用实例变量或类变量的情况下,要保证线程安全性,如有可能尽量采用ThreadLocal保存实例变量或类变量;
     4.如果不是必须,不要在循环中去定义变量或者new 对象;尽量在需要的最后一刻才去new 对象;
     5.如果不是必须,不要在循环中去用try…catch;
     6.类中对于比较复杂的逻辑要采用行注释的方式进行注释,java代码中绝对不允许采用块注释(/**/)进行注释;
     7.Java类的名称第一个子母必须大写,有多个单词组成的,每个单词的首字母大写
     8.jsp的文件名必须全部小写;
     9.Spring的bean配置文件名必须小写,格式为xxx.bean.xml,xxx.bean.xml配置文件中的f1259c733d81a36606a4aca21b3a83c6方式如

char[] buffer;

而不是

char buffer[];

4.方法编写规范

    1.对成员方法,不要轻易的采用public的成员变量。主要的修饰符有public, private, protected, 无
    2.空方法中方法声明和函数体可都在一行。如: void func(){}
    3.方法和方法之间空一行
    4.方法的文档注释放在方法的紧前面,不能空一行。
    5.避免过多的参数列表,尽量控制在5个以内,若需要传递多个参数时,当使用一个容纳这些参数的对象进行传递,以提高程序的可读性和可扩展性
    6.方法中的循环潜套不能超过2层
    7.对于设计期间不需要子类来重载的类,尽量使用final
    8.每个方法尽量代码行数尽量不要超过100行(有效代码行,不包括注释),但必须保证逻辑的完整性
    9.接口中的方法默认级别为protected,只有很确认其它子系统的包会调用自己子系统的接口中的方法时,才将方法暴露为public.

5.语言使用及书写规范

   1.避免变量的定义与上一层作用域的变量同名。
   2.方法与方法之间用需要用一空行隔开
   3.局部变量在使用时刻声明,局部变量/静态变量在声明时同时初始化
   4.在与常数作比较时常数放在比较表达式的前面如:

if(“simpleCase”.equals(obj))… if(null == obj)….

   5.return语句中,不要有复杂的运算。
   6.switch语句,需要一个缺省的分支


Kenyataan:
Kandungan artikel ini disumbangkan secara sukarela oleh netizen, dan hak cipta adalah milik pengarang asal. Laman web ini tidak memikul tanggungjawab undang-undang yang sepadan. Jika anda menemui sebarang kandungan yang disyaki plagiarisme atau pelanggaran, sila hubungi admin@php.cn
Artikel sebelumnya:java中的反射机制Artikel seterusnya:代码注释中的5要与3不要