设计原则与设计模式使用好了，能有效地改善代码质量，但非常依赖个人经验。而编码规范简单明了，在提高代码的可读性方面，立竿见影。
1、命名
- 长度：足够表达含义的情况下，越短越好；默认的、熟悉的单词可以使用缩写
- 利用上下文简化命名：借助类的信息来简化属性、函数的命名，利用函数的信息来简化函数参数的命名
- 可读、可搜索
2、注释
- "好的命名完全可以替代注释"，观点有点极端，命名不可能做到足够详细
- 注释的目的就是让代码更容易看懂
- 写明"做什么"、"怎么做"，起到总结性与文档的作用
- 让代码结构更清晰
- 在复杂的类或者接口的注释中写明"怎么用"
- 注释太多会对代码阅读产生干扰，也增加了后期的维护成本
- 注释太少过一段时间可能自己都忘记了代码的意图与作用
3、格式
- 函数的代码行数最好不要超过一屏幕的大小，方便阅读
- 代码行最好不要超过 IDE 显示的宽度
- 用空行分割单元块：成员变量、方法、方法内每小部分逻辑处理的代码，用空行进行分割
- 代码缩紧取决团队规定，两格缩紧更省空间
- 大括号是否另起一行也取决团队规定，在同一行节省行数，另起一行方便对齐
- 类中成员的排列顺序：字母顺序，先变量后函数，先静态后普通，方法可以按权限修饰符也可以按一组相关的方法放一起
- 复杂逻辑的代码提炼类和函数，分割成更小的单元块
- 参数过多（超过5个）：检查函数是否职责单一，进行函数拆分；将函数的参数封装成对象
- 尽量不要在函数中使用布尔类型的标识参数来控制内部逻辑，可以将函数拆分
- 嵌套层次不要过深，一般不超过 3 层。可以提取部分逻辑到新的函数；调整执行顺序减少嵌套；使用 continue、break、return 关键字，提前退出嵌套
- 使用解释性变量：常量取代魔法数字、将复杂的表达式赋值给解释性变量
也可以参考阿里的开发规范：https://developer.aliyun.com/special/tech-java
嫌登录麻烦，公众号回【开发手册】
图：思维导图
【Java学习资源】整理推荐
【Java面试题与答案】整理推荐
扫一扫
1029
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
