SI-代码走查报告.docVIP

PAGE2

【安全管理平台项目】

代码走查报告

文档状态：

文档编号：

ZDH-代码走查报告-01

[]草稿

[√]已发布

[]修改中

编撰：

编撰日期：

2021-6-30

保密级别：

内部公开

文档版本：

1.0

文档控制：

版本历史

日期

版本

说明

作者

2021-6-30

1.0

首次发布

保密等级定义 MACROBUTTONCheckIt?公开资料 MACROBUTTONUncheckIt?内部资料 MACROBUTTONCheckIt?保密资料 MACROBUTTONCheckIt?机密资料

代码走查报告

第PAGE4页，共NUMPAGES10页

目的

对代码走查的结果进行整理和汇总，并形成正式的测试文档；

将代码走查的报告以及结果纳入配置管理库。

参考资料

《JAVA语言编码规范》

《NET编码规范》

《安全编程规范》

《代码走查规程》

代码检查项

评审对象：系统登陆

序号

总则条款

执行情况

说明

1命名规则

1

1.1命名规则是否与所采用的规范保持一致

是

2

1.2是否遵循了最小长度最多信息原则

是

3

1.3has/can/is前缀的函数是否返回布尔型

是

2注释

4

2.1注释是否较清晰且必要

否

代码由多位组员进行编写，部分代码为及时更新注释

5

2.2复杂的分支流程是否已经被注释

是

6

2.3距离较远的}是否已经被注释

是

7

2.4非通用变量是否全部被注释

是

8

2.5函数是否已经有文档注释

否

代码由多位组员进行编写，部分代码未及时更新注释

9

2.6特殊用法是否被注释

是

10

2.7当代码有变更时是否更新了注释

是

3声明空白缩进

11

3.1每行是否只声明了一个变量（特别是那些可能出错的类型）

是

12

3.2变量是否已经在定义的同时初始化

是

13

3.3类属性是否都执行了初始化

是

14

3.4代码段落是否被合适地以空行分隔

是

15

3.5是否合理地使用了空格使程序更清晰

是

16

3.6代码行长度是否在要求之内

是

17

3.7折行是否恰当

是

4语句/功能划分/规模

18

4.1包含复合语句的{}是否成对出现并符合规范

是

19

4.2是否给单个的循环、条件语句也加了{}

是

20

4.3if/if-else/if-elseif-else/do-while/switch-case语句的格式是否符合规范

是

21

4.4单个变量是否只做单个用途

是

22

4.5单行是否只有单个功能（不要使用；进行多行合并）

是

23

4.6单个函数是否执行了单个功能并与其命名相符

是

24

4.7操作符++和--操作符的应用是否复合规范

否

代码由多位组员进行编写

25

4.8单个函数不超过规定行数

是

26

4.9缩进层数是否不超过规定

是

5可靠性（总则/变量和语句）

27

5.1是否已经消除了所有警告

是

28

5.2常数变量是否声明为final

是

29

5.3对象使用前是否进行了检查

是

30

5.4局部对象变量使用后是否被复位为NULL

是

31

5.5对数组的访问是否是安全的（合法的index取值为[0,MAX_SIZE-1]）

是

32

5.6是否确认没有同名变量局部重复定义问题

是

33

5.7程序中是否只使用了简单的表达式

是

34

5.8是否已经用（）使操作符优先级明确化

是

35

5.9所有判断是否都使用了（常量==变量）的形式

是

36

5.10是否消除了流程悬挂

是

37

5.11是否每个if-elseif-else语句都有最后一个else以确保处理了全集

是

38

5.12是否每个switch-case语句都有最后一个default以确保处理了全集

是

39

5.13for循环是否都使用了包含下限不包含上限的形式（k=0;kMAX）

是

40

5.14XML标记书写是否完整，字符串的拼写是否正确

是

41

5.15对于流操作代码的异常捕获是否有finally操作以关闭流对象

是

42

5.16退出代码段时是否对临时对象做了释放处理

是

43

5.17对浮点数值的相等判断是否是恰当的（严禁使用==直接判断）

是

6可靠性（函数）

44

6.1入口对象是否都被进行了判断不为空

是

45

6.2入口数据的合法范围是否都被进行了判断(尤其是数组)

是

46

6.3是否对有异常抛出的方法都执行了try...catch保护

是

47

6.4是否函数的所有分支都有返回值

是

48

6.5int的返