注释规范是整个开发规范中最为重要的组成部分,必须严格执行。
ALT+SHIFT+J快捷键
可以用eclipse的导入注释模版的形式
Window->Preferences->Java->Code Style->Code Templates
到wiki上下载注释的模版文件
类的注释:
作用:注释整个类,简单概述该类作用。
书写规范:类的注释必须写在该类的声明语法之前。在注释中要描述该类的基 本作用,作者,日期,版本,公司名称。
格式:
/* *
类功能描述:(大致描述类的功能)
@author:编写者名称
@version: 类文件的版本号 从1.0开始(自己确定版本号的增改
情况), 修改情况(修改时间、作者、改动情况)
*@Since:2012-12-12
相关数据如:(便于理解本类的一些常量数据及某些数据的格式
或认为比较重要的数据,如果没有可省略)
*/
类的声明语法
例如:
/**
Title:管理员模块数据处理类
Description: 两个数相加
@author 张三
*@Since:2012-12-12
@version V1.0
*/
public class AdminDAO
变量、常量注释:
作用:简单描述该变量的意义。
书写规范:变量注释必须写在变量定义之前,简单描述其代表的意义。
格式:
/**
变量功能描述:(大致描述变量的功能)
*/
例如:
/**
定义年龄变量
/
public int age;
方法注释:
作用:对该方法功能简单描述,其参数、返回值意义的注解。
书写规范:方法注释必须写在方法定义之前。该注释包括:方法其功能的简单 描述,方法的参数、返回值类型、返回值意义简单的描述。
格式:
/**
方法功能说明
@param args (参数类型可以写在参数后,也可以省
略。每个参数占一行)
@return 输出参数(多种情况写在同一行)
@exception 异常处理类(方法中能够引发的异常,每
个异常占一行)
*/
例如:
/**
修改管理员密码
@param adminId 管理员编号
@param oldPassword 旧密码
@param password 新密码
@return boolean 是否编辑成功
@throws UserException
@throws ServiceException
*/
public booleaneditAdminPassword(int adminId,String oldPassword,
String password) throws UserException,ServiceException;
每一个模块完成后,在src/test/java中加入junit测试方法,测试类所在的包的命名在测试的模块所在的包名后加入test,例:
com.osen.app.mod.模块名.test
测试类的命名:模块名Test。例如:测试User模块,则测试类为UserTest.java
事物控制事物控制统一在逻辑层的实现类中以注解的形式添加,例如:
对UserServiceImpl中的addUser方法需要进行事物控制,操作如下:
1.此方法必须为public
2.在方法名上边加入
@Transactional(propagation=Propagation.REQUIRED,rollbackFor=Exception.class)
此注解含义为:如果当前方法没有事物,则加入事物,如果当前方法存在事物,则使用当前方法的事物。事物所控制的异常类型为Exception,即对所有属于exception的异常进行事物回滚。
3.具体注解参数根据实际业务需要进行适当添加和修改。
注意:需要进行事物控制时,在方法名称上边添加事物注解,不要在类名上边添加全局事物注解,以免影响效率。
mapper接口规则每新建一个mapper接口类,需要继承mapper接口基类BaseMapper,例如:
public interface UserMapper extends BaseMapper
接口基类BaseMapper还不完善,大家在开发过程中有需要提取公用接口到BaseMapper中时,请及时提出,共同讨论,以便进一步完善。
之前已经写好的mapper类,如果业务改动量较小,也请添加继承BaseMapper