混乱会造成复杂,而有序会减少复杂度,制定规范是从无序走向有序,减少认知成本。
1、空行规范
试想,长篇大论的文章和一个个小段落组成的文章,你一眼瞧过去更愿意阅读哪个?—— 由空行分出小段落比大段文字有更好的可读性。
在代码里,最好将相关性比较强的代码放在一起,关联性越强彼此之前的距离就应该越短。
举个栗子
空行分隔之前:
public boolean test() {
// 保存人员信息
Person per = new Person();
per.setName("张三");
per.setId(123);
per.setSex(1);
perService.save(per);
// 保存课程信息
Course cour = new Course();
cour.setPerId(per.getId());
cour.setName("语文");
courService.save(cour);
LoggerUtil.info("保存人员信息和课程信息成功!per: " + JSON.toJSONString(per) + " cour: " + JSON.toJSONString(cour));
return true;
}
空行分隔之后:
public boolean test() {
// 保存人员信息
Person per = new Person();
per.setName("张三");
per.setId(123);
per.setSex(1);
perService.save(per