一、格式
(一)、垂直格式
-
尽量用200~500行为单个文件。
-
源码应该像报纸一样:上面是大纲,下面是细节。最顶部应该是高层次概念和算法,细节应该依次向下展开,放在我们代码里意思就是:public方法应该放在上面,private方法应该放在下面。应该是一个总分结构。
-
概念上垂直方向的区隔
代码中是需要一些空行的,方法间必须要有空行,方法中:两段功能不同的代码中也需要空行,以区别不同的代码段,但这个尺度需要掌握好,空行特别多时也会影响阅读。所以若干很短比如只有一行的代码段就无需再空行了
String name = “A”;
Int age = 10;
String sex = “男”;User user = new User();
User.setName(name);
User.setAge(age);
User.setSex(Sex);Mapper.insertUser(user);
-
垂直方向上的靠近
与上面相反,一些功能或概念相似的代码段是应该放在一起的,比如我上面的代码中把变量初始化放在一起,new一个对象的过程放在一起。这样很容易知道它们是相似的。在类中也应该是这样,私有变量放在一起,公有变量放在一起。 -
垂直距离
关系密切的概念应该相互靠近,条件是在同一个文件中。其实并不应该把关系密切的概念放在不同文件,所以应该避免使用protexted变量。
a. 变量的声明应该靠近其使用位置,比如我们写循环的控制变量一般就放在循环上面。
b. 实体