常用的一些代码书写规范

转载

mb5fe947dd062d3 2017-04-14 21:07:00

1.包名：不能有大写，包命名全部小写，包名就是src-main-java下的包名，包名要与公司组织名一致

2.类注释：5行，两个*打头，@author。且每个类上面要有两个**的注释，非1个星的注释。5行

/**
 * 首页入口controller
 * 
 * @author PANXUEJUN725
 */
@RestController
@RequestMapping("/homepage")
public class AccessController

3.成员变量隔行：隔行，隔行，声明类的成员变量要隔行，隔两行。常量的声明更是如此。

public class ResultDTO implements Serializable{

    private static final long serialVersionUID = 3674335342463035834L;
    
    //状态码
    private String statusCode;
    
    //提示信息
    private String msg;
    
    //返回数据
    private List<Object> dataList;

常量声明

public class PAPConstants {

//异常类名返回提示
public static final String PAP_ERROR_CLASS = "error_class";

//异常码error code提示
public static final String PAP_ERROR_CODE = "error_code";

//异常信息error_msg提示
public static final String PAP_ERROR_MSG = "error_msg";

}

4.类第一行隔行：里面，第一行要隔断。隔断类里面的第一行。不要紧挨着写类的成员变量声明。

public class ResultDTO implements Serializable{

    private static final long serialVersionUID = 3674335342463035834L;
    
    //状态码
    private String statusCode;
    
    //提示信息
    private String msg;
    
    //返回数据
    private List<Object> dataList;

5.花括号风格：c++风格或者java风格，遵从一种。

    public static DaoException createDaoException(String msg, Logger logger) {
        DaoException daoException = new DaoException(msg);
        logger.error(msg, daoException);
        return daoException;
    }
    
    public static ValidationException createValidationException(String msg, Logger logger) {
        ValidationException validationException = new ValidationException(msg);
        logger.info(msg, validationException);
        return validationException;
    }