java代码规范¶
代码基本规范:¶
java代码需要通过代码检测工具 SonarLint
命名规范
定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。
Package 的命名
Package 的名字应该都是由一个小写单词组成。示例:unipost.trans
Class 的命名
Class 的名字每个单词必须由大写字母开头而其他字母都小写的单词组成。示例:FileMng
Class 成员的命名
变量、方法、属性:大小写混排的单词组成,首字母小写
示例: functionName、countNum、size
Static Final 变量的命名
Static Final常量:大写单词组成,单词之间使用“_”连接
示例: MAX_INDEX
代码版本规范:¶
JDK版本只有两个选择:JDK8和JDK17
常用文件下载:¶
其他规范:¶
每一个项目都要写好readme.md文件,写不同环境切换时需要修改和注意的事项,比如:不可或缺的基础数据,切换时需要更改的域名。需要依赖的第三方包或者插件等。