规范文档

IntelliJ IDEA导包顺序设置

防止提交代码冲突

1.进入设置,Editor -> Code Style -> Java,定位到Imports标签页

1.png

2.默认情况下,import同一个包下的3个类就会以*代替 ,所以此处需要设置一个很大的值,比如99

2.png

3.修改导包顺序:

import static all other, 
空行
import java.*, 
空行
import javax.*, 
空行
import org.*, 
空行
import com.*, 
空行
import all other imports

3.png 4.png

项目目录结构

src -- 源码目录
├── config -- 存放系统配置文件类
├── common -- 存放枚举类
├── enums  -- 存放枚举类
├── modules -- 存放所有业务模块(单应用多模块)
	├── xxx模块 -- xx模块业务
		├── bo -- 请求参数处理的业务BO
			├── request  -- 入参
    		└── response -- 出餐
    	├── po -- 数据库实体映射
    	├── mapstructs -- bo和po互相转换的工具
    	├── controller -- controller请求入口类
    	├── mapper -- mybatis mapper入口
    	└── service -- 业务服务接口
    		└── impl -- 业务服务接口实现类
├── events -- 存放所有的事件
└── utils -- 工具类

提交记录规范

<type>(<scope>): <subject>
// 注意冒号 : 后有空格
// 如 feat(miniprogram): 增加了小程序模板消息相关功能

scope选填表示commit的作用范围,如数据层、视图层,也可以是目录名称

subject必填用于对commit进行简短的描述

type必填表示提交类型,值有以下几种:

  • feat - 新功能 feature
  • fix - 修复 bug
  • docs - 文档注释
  • style - 代码格式(不影响代码运行的变动)
  • refactor - 重构、优化(既不增加新功能,也不是修复bug)
  • perf - 性能优化
  • test - 增加测试
  • chore - 构建过程或辅助工具的变动
  • revert - 回退
  • build - 打包
0%