Java编码规范,让你的代码赏心悦目--格式
2017-09-05 22:18
295 查看
垂直格式
源代码该有多大?短文件通常比长文件易于理解;
垂直方向上的靠近
空白行隔开了概念,靠近的代码行则暗示了它们之间的紧密关系;
这条规则不适用于分布在不同文件中的概念。除非有很好的理由,否则就不要把关系密切的概念放到不同的文件中。这也是避免使用protected变量的理由之一。
变量声明应尽可能靠近其使用位置。因为函数较短,本地变量应该在函数的顶部出现。
循环中的控制变量应该总是在循环语句中声明;
实体变量应该在类的顶部声明;这应该不会增加变量的垂直距离,因为在设计良好的类中,它们如果不是被该类的所有方法也是被大多数方法所用;
若某个函数调用了另外一个,就应该把它们放到一起。而且调用者应该尽可能放在被调用者上面。
概念相关的代码应该放到一起。相关性越强,彼此之间的距离就该越短;
横向格式
使用空格将彼此紧密相关的事物连接到一起,也用空格把相关性较弱的事物隔开;
在赋值操作符周围加上空格字符,达到强调的目的。通过等号两边的空格加强了左右两边的分隔;
最好不要在函数名和左边的括号加空格,这表示其函数与其参数密切相关,如果隔开会显得互无关系。
把函数调用括号中的参数一一隔开,强调逗号,表示参数是互相分离的;
空格还可以强调前面的运算符
有时,while和for语句的语句体为空,这样的结构最好不要使用;
本页笔记提出的所有内容都需要将团队规则放在第一要务!!!
源代码该有多大?短文件通常比长文件易于理解;
垂直方向上的靠近
空白行隔开了概念,靠近的代码行则暗示了它们之间的紧密关系;
这条规则不适用于分布在不同文件中的概念。除非有很好的理由,否则就不要把关系密切的概念放到不同的文件中。这也是避免使用protected变量的理由之一。
变量声明应尽可能靠近其使用位置。因为函数较短,本地变量应该在函数的顶部出现。
循环中的控制变量应该总是在循环语句中声明;
实体变量应该在类的顶部声明;这应该不会增加变量的垂直距离,因为在设计良好的类中,它们如果不是被该类的所有方法也是被大多数方法所用;
若某个函数调用了另外一个,就应该把它们放到一起。而且调用者应该尽可能放在被调用者上面。
概念相关的代码应该放到一起。相关性越强,彼此之间的距离就该越短;
横向格式
使用空格将彼此紧密相关的事物连接到一起,也用空格把相关性较弱的事物隔开;
在赋值操作符周围加上空格字符,达到强调的目的。通过等号两边的空格加强了左右两边的分隔;
最好不要在函数名和左边的括号加空格,这表示其函数与其参数密切相关,如果隔开会显得互无关系。
把函数调用括号中的参数一一隔开,强调逗号,表示参数是互相分离的;
空格还可以强调前面的运算符
有时,while和for语句的语句体为空,这样的结构最好不要使用;
本页笔记提出的所有内容都需要将团队规则放在第一要务!!!
相关文章推荐
- Java编码规范,让你的代码赏心悦目--格式
- Java编码规范,让你的代码赏心悦目--格式
- Java编码规范,让你的代码赏心悦目--格式
- Java编码规范,让你的代码赏心悦目--格式
- Java编码规范,让你的代码赏心悦目--格式
- Java编码规范,让你的代码赏心悦目--格式
- Java编码规范,让你的代码赏心悦目--格式
- Java编码规范,让你的代码赏心悦目--格式
- Java编码规范,让你的代码赏心悦目--格式
- Java编码规范,让你的代码赏心悦目--格式
- Java编码规范,让你的代码赏心悦目--格式
- Java编码规范,让你的代码赏心悦目--格式
- Java编码规范,让你的代码赏心悦目--格式
- Java编码规范,让你的代码赏心悦目--格式
- Java编码规范,让你的代码赏心悦目--有意义的命名
- Java编码规范,让你的代码赏心悦目--函数
- Java编码规范,让你的代码赏心悦目--对象和数据结构
- Java编码规范,让你的代码赏心悦目--错误处理
- Java编码规范,让你的代码赏心悦目--有意义的命名
- Java编码规范,让你的代码赏心悦目--函数