工程能力（篇二）

目录

代码检查规则：java语言案例详解

java的代码检查规则（总览如下）

java的代码检查规则（逐一详解如下）

源文件规范

源文件组织结构规范

代码结构规范

命名规范

OOP规约

​编辑

集合处理规范

​编辑

控制语句规范

​编辑

注释规约

​编辑

异常处理规范

​编辑

缺陷检查规则

​编辑

单元测试之java实践

如何写单元测试

基本流程

测试替身

设计思路

断言（Assertions）

单元测试的运行

如何判断单元检测的质量

如何做好Code Review

了解一流代码的特性

会判断bad code

注意事项

Code Review步骤

关于Python编程规范的部分说明

---

代码检查规则：java语言案例详解

java的代码检查规则（总览如下）

1. 源文件规范；
2. 源文件组织结构规范；
3. 代码结构规范；
4. 命名规范；
5. OOP规约；
6. 集合处理规范；
7. 控制语句规范；
8. 注释规约；
9. 异常处理规范；
10. 缺陷检查规则；

java的代码检查规则（逐一详解如下）

源文件规范

• 文件名

1. 与源文件包含的顶层类名保持一致，包括大小写；
2. 以.java作为后缀名；

• 文件编码

UTF-8格式；

• 特殊字符

换行、缩进、空格等操作的强制规则；

源文件组织结构规范

源文件包含：许可证或版权声明、package语句、import语句、唯一的顶层类；

代码结构规范

• 花括号

1. 在非空代码块中遵循K&R风格；
2. 三个主要原则；

• 缩进与换行

提升代码的可维护性；

• 空行

1. 在类的不同成员之间增加空行；
2. 两个成员变量声明之间可以不加空行；
3. 方法体内，按需增加空行；
4. 使用空行时，禁止使用连续的空行；

• 其他说明

1. java中有两种数组定义形式；
2. 当注解与注释同时存在时；
3. 当同时存在多个修饰符时，需要按照顺序书写；
4. 避免l与1混淆；

命名规范

• 驼峰命名格式
• 类的命名格式
• 常量命名格式

1. 常量命名全部大写，单词间用下划线隔开；
2. 不允许任何未经预先定义的常量直接出现在代码中；

OOP规约

 

集合处理规范

 

控制语句规范

• 控制语句：switch语句、if语句、else语句、while语句；
• 具体规范如下

 

注释规约

• java中的注释主要分三种形式

1. 文档注释；
2. 单行注释；
3. 多行注释；

• 具体规约如下

 

异常处理规范

• try语句和catch语句捕获异常处理；
• java中的异常分为“运行时异常”与“非运行时异常”；
• 具体规范如下

 

缺陷检查规则

 

 

 

单元测试之java实践

如何写单元测试

基本流程

环境初始化->准备输入参数->调用待测试方法->检查输出->测试完成后环境复原

测试替身

1. Stub；
2. Fake；
3. Spy；
4. Mock；

设计思路

应用场景+输入数据+功能实现=输出数据；

断言（Assertions）

常见的断言如下

单元测试的运行

分“手动运行”与“自动运行”两种方式；

如何判断单元检测的质量

分“主观层面”和“客观层面”（具体如下）

如何做好Code Review

了解一流代码的特性

会判断bad code

比如：5分钟之内看不懂的代码、没有空行或注释的代码等等；

注意事项

比如：必要时，review的双方做面对面的沟通；对于关键模块，应该建立owner制度；对于发现的问题，一追到底；注意细节；......

Code Review步骤

关于Python编程规范的部分说明

• 模块的划分
• 数据的封装
• import
• 异常
• 构造函数
• 函数返回值
• 代码长度
• 空行、空格
• 注释