JAVA服务端代码规范梳理

1、代码注释

1）类使用统一注释模板

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
*
*@since 0.1.0 //随着功能版本修改
*@since ${YEAR}-${MONTH}-${DAY}
*@version ${revision} //不需要修改
*@Author ${USER}
*@see
*/
public class ${NAME} {
}

2)方法使用统一注释

/**
 * （功能描述）
 *
 * @param x'x'x
 * @param x'x'x
 * @return x'x'x
 */

2、server端方法名命名

1）方法名使用业务清晰的命名方式，这样接手的新人，容易通过方法名称来理解代码业务。

错误例子：
find...By...And...
update...By...And...
delete...By...And...

2）新建、添加、新增差别

UserService.createUser() // 新建，无中生有，insert user
GroupService.createGroup() // 新建，无中生有，insert group
GroupService.addUserToGroup() // 添加，加入关系，insert userInGroup
GroupService.createUserToGroup() // 新增，无中生有后加入关系, insert user, insert userInGroup