一、命名规范:

  1. 类名的首字母必须大写。
  2. 所有成员变量、方法命名时,必须遵守骆驼命名法。
    范例:
    openAccount();
    save();
    getFirstName();
    isAtEnd();
  3. 一般运算符两边都必须有空格+、-、*、/、%、=、<、>、!=、<=、>= 两边空格,如:
    String name = “zn”;
    2 – 1; 2 + 1; 2 * 1; 2 / 1; 2 % 1; 2 > 1;
    2 > 1; 2 != 1; 2 <= 1; 2 >= 1;
    一元运算可以除外,比如:i++; i--; ++i; --i;
  4. 书写{ }采用如下格式:
    public interface Interface {
        public void showMessage() {

       }
    }
  5. 抽象类以Abstract开头;
    public class AbstractCollection
  6. 接口的实现使用Impl结尾;
    public class IteratorImpl implements Iterator
  7. 静态不可变的变量全部使用大写,并且单词之间用_进行分隔:如
    public static final int MAX_VALUE = 5;
  8. 包名由小写字母和少量数字组成,包名统一用代表模块贴切含义的英文单词或缩写;
  9. 包名一级为com;
  10. 包名二级为jb;
  11. 包名三级为班级编号,如s1t001;
  12. 包名四级为小组名,如crazy;
  13. 包名五级按功能模块划分等,如oofood

二、注释要求

    注释是帮助程序读者的一种手段在编码的过程中必须随时加注释。不能过后补齐。通过注释描述当时的思路,以及悬而未决的问题;提高程序的可读性,规范性,维护性。提供使用说明、及配置信息。
  1. 每行注释不超过40个中文字
  2. 每个类、接口的开头必须多行的详细的功能说明,使用中文注释,包括作者、版本、创建时间等等。
  3. 每個方法前面都必須使用Javadoc的中文注释,必须说明该方法的作用与目的。
  4. 每个成员变量必须有单行中文注释,必须说明该成员变量的作用与目的。

    类注释

    /**
    * 作者:张三
    * 功能:现存量业务逻辑
    * 日期:2003-2-19
    */

    方法注释

        方法头注释必须包括:方法执行了什么功能,为什么要这样处理;方法处理过程中对对象的那些属性可能进行更改;方法执行前后,对象的状态。
    1. 比较、循环等控制结构必须加注释;
    2. 在代码的功能并非一目了然的情况下,应当说明为什么要这样做;
    3. 局部变量必须加注释;
    4. 复杂难写的代码必须加注释;
          如果一系列代码的前后执行顺序有要求,必须注释说明方法开头需要的注释内容:作者、功能、参数说明、返回值、例外、日期、修改日期,修改人,修改原因。举例:
    /**
    * 作者:张三
    * 功能:查询现存量
    * 参数: voCond:查询条件VO     voAstCond:附加条件VO
    * 返回:ResultVO:查询结果
    * 例外:DatabaseException
    * 日期:2001-04-15
    * 修改日期,修改人,修改原因,注释标志:
    * 2001-06-16,李四,提高效率,lisi_begin/lisi_end
    * 2001-07-16,王五,提高效率,wangwu_begin/wangwu_end
    */

    变量注释

    要求注释所有的变量(域)。如下所示:
    /** 标题 */
    private String title = null;
    /** 订单VO */
    private PurchaseBillVO purchaseBillVO = null;
    如果该注释不用来生成javadoc文件:也可以采用以下形式:
    //标题
    private String title = null;
    //订单VO
    private PurchaseBillVO purchaseBillVO = null;