后端开发规范总结

 

开发规范总结

1.类的注释
 /**
  * @author wupeng
  * @version v1.0
  * @create 2017-07-25 19:39
  * @decription 类的说明xxxxx
  **/

2.controller的注释
 @Api(value = "编号+ 接口说明")
 @RestController
 @RequestMapping(value = "/v1/rivers")
 @RefreshScope
 
3. 每个方法的注释：
 /**
  *查询 ：说明
  */
 @ApiOperation(value="添加xxxxx", notes="添加xxxxx")
 @ApiImplicitParams(value={
   @ApiImplicitParam(name = "userId", value = "登陆用户id", required = true, dataType = "Integer",paramType = "query")
 })
 @RequestMapping(value="", method=RequestMethod.POST)
 public int save (@RequestParam(value = "userId", required = true) String userId){ }
 
 以上：
 增删改查 方法名称：save update delete search
 swagger参数规范 ：dataType 一定要写清楚 这是给前端同事看的

4. 方法与方法之间的回车为1个

5. 接口中方法与方法之间的注释规范：
 /** 这是一个注释 **/

6. 抛出异常用codeConstant

7.mybatis xml 每一个增删改查的sql都要打注释（这个以防以后很难搞懂）