双人项目代码规范

通过对软件工程这门课的学习，让我意识到代码规范的重要性，阅读了《java开发手册》v1.5.0华山版和华为编码规范（c语言版）之后，我对双人项目的代码编写做了如下的简易规范：

1.对于代码分行也应有相关规范，不允许把多个短语句写在同一行中，即一行只能写一个短语句，严格点来说，就是不能把多个变量定义在一行上。

2.对于代码的断行和空白的{ }行也要有规范，程序块的分界符（如C/C++语言的大括号‘{’和‘}’）应各独占一行并且位于同一列，同时与引用它们的语句左对齐，并且if、for、do、while、switch、case语句中的程序也应该按照以上规范进行编写。

3.单元测试应该是全自动执行的，并且非交互式的。测试用例通常是被定期执行的， 执行过程必须完全自动化才有意义。输出结果需要人工检查的测试不是一个好的单元测试。 单元测试中不准使用 System.out来进行人肉验证，必须使用 assert来验证。 

4.保持单元测试的独立性。为了保证单元测试稳定可靠且便于维护，单元测试用例之 间决不能互相调用，也不能依赖执行的先后次序。 

5.避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命 名，使可读性降低。 

6.接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁 性，并加上有效的Javadoc注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定 是与接口方法相关，并且是整个应用的基础常量。 

7.单行字符数限制不超过120个，超出需要换行，换行时遵循如下原则：  1）第二行相对第一行缩进4 个空格，从第三行开始，不再继续缩进，参考示例。  2）运算符与下文一起换行。  3）方法调用的点符号与下文一起换行。  4）方法调用中的多个参数需要换行时，在逗号后进行。  5）在括号前不要换行。

8.不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。 

9.核心业务、核心应用、核心模块的增量代码确保单元测试通过。 

通过阅读，让我我认识到代码规范的重要性。在以后的代码编写时我会更加注重代码是否规范，提高自己代码编写能力的同时优化简洁代码，码出质量。

标签：语句,换行,代码,单元测试,规范,编写,双人
来源： https://www.cnblogs.com/lichunjuan/p/13834469.html