代码规范

命名规范

  • 驼峰式
  • 见名知意

注释规范

单行注释

	// 单行注释

多行注释

	/*
	 * 多行注释
	 */

函数注释

	/**
	* 描述
	* @param reqVO
	*/

类注释

/**
 * XXX模块,业务接口实现类
 * @author: yks
 * @create: 2021-01-21
 **/

接口规范

URL路径

尽可能符合Restful风格

入参

超过两个参数,尽可能使用对象封装

响应内容

  • Rpage

  • R

log规范

	log.info("msg", e);

错误提示规范

ErrorMsgConstant记录错误提示

判空规范

使用Objects.equals()/常量.equals(b);尽可能避免NPE

Objects.equals(a,b);
原文地址:https://www.cnblogs.com/yks43/p/14346895.html