软件代码审查报告

【#文档大全网# 导语】以下是®文档大全网的小编为您整理的《软件代码审查报告》，欢迎阅读！

软件代码审查报告

检查人： 检查日期：

审查内容： 审查总结果： 说明：

审查类型

一、注释



8

9 10

6 7

4 5 3

2 序号 1

程序文件头部应进行注释，务必列出：版权说 明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。 有头文件没有源文件的要说明



条款与说明

源代码有效注释量必须达到20%以上

审查结果

函数头部应进行注释，列出：函数的目的/功能、 输入参数、输出参数、返回值、调用关系等。 编写代码边注释



注释的内容要清楚、明了，含义明确，防止注 释二义性

避免在注释中使用缩写，特别是非常用缩写



注释应与其描述的代码相近，对代码的注释应 放在其上方或右方相邻位置。

数据结构申明(包括数组、结构、类、枚举等)， 如果其命名不是充分自注释的，必须加以注释。 全局变量要有交详细的注释，包括对其功能、 取值范围。

对于switch语句下的case语句，如果因为特殊


11

情况需要处理完一个case后进入下一个case处理，必须在该case语句处理完、下一个case语句前加上明确的注释。





二、标识符命名

1

标识符的命名要清晰、明了，有明确含义，同 时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解。

2 3 4

命名中若使用特殊约定或缩写，则要有注释说 明。

自己特有的命名风格，要自始至终保持一致， 不可来回变化。

对于变量命名，禁止取单个字符（如i、j、k...）， 建议除了要有具体含义外，还能表明其变量类型、数据类型等，但i、j、k作局部循环变量是允许的。

5

命名规范必须与所使用的系统风格保持一致， 并在同一项目中统一，比如采用UNIX的全小写加下划线的风格或大小写混排的方式，不要使用大小写与下划线混排的方式。

三、可读性

1 2

注意运算符的优先级，并用括号明确表达式的 操作顺序，避免使用默认优先级

避免使用不易理解的数字，用有意义的标识来 替代。涉及物理状态或者含有物理意义的常量，不应直接使用数字，必须用有意义的枚举或宏来代替。

本文来源：https://www.wddqxz.cn/e737aca18ad63186bceb19e8b8f67c1cfbd6ee06.html