代码规范是使代码达到可读的关键。这里根据笔者自己的一些经验和实践，列出一些最需要遵循的Java编码规范。
1.变量命名按照Java通用方式Camel命名法。常量尤其注意使用全大写_（下划线链接）单词的方式，如USER_KEY
2. 变量和类命名务必具有意思，能让人一眼看出表示的意思。如userList标识用户列表
3. 数据库的一个表对应一个领域类，以entity、domain作为包名都可以。
4. 数据访问层命名形如xxxDao，这里应该封装所有与数据库层面的东西，如表名、各个列等
5. Service类是封装业务逻辑的类，其中的方法要和此业务逻辑相关，比如UserService就 和User相关的业务方法
6. 当一个东西具有缓存和实际值的时候，务必保证存储和获取的接口只有一个。比如获取用户的level，应该旨在UserLevelService中暴露一个接口提供。
7. 当一个方法具有缓存和实际值的时候，务必考虑封装方法或者类。
对于以上这些规范，可以使用CheckStyle、PMD等工具进行保证，使用相关的maven插件即可。
CheckStyle：
1.Javadoc注释
2. 命名规范
3. 多余没用的Imports。
4. Size度量，如过长的方法
5. 缺少必要的空格 Whitespace。
6. 重复代码
关于CheckStyle的使用 限于篇幅本人推荐文章：https://blog.csdn.net/weixin_36380516/article/details/85000491
虽然以上工具已经可以告警不符合规范的代码，但仍然需要通过团队成员之间的代码审校才能进一步保证开发规范的实践。
务必撰写文档，尤其对于一些逻辑复杂的项目或者模块，需要包括一下文档：项目/模块的介绍文档；QuickStart，按照文档说明应该能在1小时内完成代码构建和简单实用；详细说明文档，
比如主要逻辑流程、接口定义、参数含义、设计等。
在代码无法阐述设计意图的时候，注释是必要的。但注释不易过多，过多证明代码的可读性有问题
防御性编程：处理异常、不要相信外部输入、不要相信外部依赖。
简洁与抽象：最好的代码抽象是对现实概念的映射。即只要有相关知识，每个类的作用都能在第一时间令人明白。但千万不要过度抽象，过渡的抽象反而会降低代码质量。
代码的可重用：代码的可重用是优秀工程师的一个本能，但切记不能为了复用而复用。
程序需要状态，对象不需要状态。程序的状态应该由数据库、缓存、任务队列这些外部容器来统一容纳，处理时仅仅在对象的方法中以局部变量的形式循环。
原文：https://www.cnblogs.com/hochan100/p/14855479.html